#35831: Include ModelForm and its Meta options in reference docs
-------------------------------------+-------------------------------------
Reporter: jernwerber | Owner:
Type: | jernwerber
Cleanup/optimization | Status: assigned
Component: Documentation | Version:
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by jernwerber):
Yep, that makes sense. I've structured by going through the possible/valid
attributes for `ModelFormOptions` and detailing what each would
accept/expect and the kinds of errors one might expect to see if something
goes wrong.
I wasn't sure where to situate it in the docs since "models.txt" is
already taken by the `modelform_factory` and `modelformset_factory` docs
so for now I just put it under its own thing.
I've done a first pass, here: https://github.com/jernwerber/django/blob
/docs-modelform-meta/docs/ref/forms/modelform-meta.txt, but before doing
some of the formatting (like breaking lines at 80 characters) and making a
PR, is there a (non-PR) workflow for this to be reviewed?
Replying to [comment:2 Clifford Gama]:
> Hi @jernwerber, and thanks for taking the time to create this ticket.
>
> I agree. The reference for `ModelForm` and the `Meta` options should be
[https://docs.djangoproject.com/en/dev/ref/forms/models/ here]. Although
I'm not sure how much we should include there given most of the
information is covered in the topic. I think we should start with the
signatures, descriptions and the list of Meta options along with what they
do.
--
Ticket URL: <https://code.djangoproject.com/ticket/35831#comment:4>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/010701928d331d31-7f9985e0-adb4-4095-a6ab-7ba414d73edd-000000%40eu-central-1.amazonses.com.
