[Django] #35831: Reference page for ModelForm Meta and ModelFormOptions

8 views
Skip to first unread message

Django

unread,
Oct 12, 2024, 2:22:03 AM10/12/24
to django-...@googlegroups.com
#35831: Reference page for ModelForm Meta and ModelFormOptions
-------------------------------------+-------------------------------------
Reporter: jernwerber | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: | Severity: Normal
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
ModelForm and the use and structure of a Meta inner class to control what
it outputs is covered mostly by way of a topic,
[https://docs.djangoproject.com/en/5.1/topics/forms/modelforms/ Creating
Forms from Models].

As a developer, it would be helpful to be able to have a consolidated
reference for the complete set of possible Meta options (ModelFormOptions)
that can be used with a ModelForm's Meta class in a single place, rather
than having to infer options from other topics or check the Python source.
--
Ticket URL: <https://code.djangoproject.com/ticket/35831>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Oct 12, 2024, 2:22:31 AM10/12/24
to django-...@googlegroups.com
#35831: Reference page for ModelForm Meta and ModelFormOptions
-------------------------------------+-------------------------------------
Reporter: jernwerber | Owner:
Type: | jernwerber
Cleanup/optimization | Status: assigned
Component: Documentation | Version:
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by jernwerber):

* owner: (none) => jernwerber
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/35831#comment:1>

Django

unread,
Oct 14, 2024, 3:26:48 AM10/14/24
to django-...@googlegroups.com
#35831: Reference page for ModelForm Meta and ModelFormOptions
-------------------------------------+-------------------------------------
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
-------------------------------------+-------------------------------------
Changes (by Clifford Gama):

* stage: Unreviewed => Accepted

Comment:

Hi jernwerber, and thanks for taking the time to create this ticket.

I agree. The reference 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:2>
Reply all
Reply to author
Forward
0 new messages