Re: [Django] #35831: Include ModelForm and its Meta options in reference docs

[Django]

#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.

[Django]

#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: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by jernwerber):

* has_patch: 0 => 1

Comment:

I have created a draft PR for these changes:
[https://github.com/django/django/pull/18699 PR]

Note: There is still a `make` warning because I have not added this to any
toctrees. Not sure where it should go since the most relevant location is
already taken by another ModelForms topic-- I wasn't sure if I could make
the call to move things around.
--
Ticket URL: <https://code.djangoproject.com/ticket/35831#comment:5>

[Django]

#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: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Clifford Gama):

* needs_better_patch: 0 => 1

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

[Django]

#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: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by jernwerber):

* needs_better_patch: 1 => 0

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

[Django]

#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: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce):

* needs_better_patch: 0 => 1

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

[Django]

#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: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mustafa Pirbhai):

* needs_better_patch: 1 => 0

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

[Django]

#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: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Mustafa Pirbhai):

Hello, just a first attempt at picking up something that needs to be
finalized. If on the right track I'll change it over to me.
--
Ticket URL: <https://code.djangoproject.com/ticket/35831#comment:10>

[Django]

#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: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce):

* needs_better_patch: 0 => 1

Comment:

Replying to [comment:10 Mustafa Pirbhai]:

> Hello, just a first attempt at picking up something that needs to be
finalized. If on the right track I'll change it over to me.

[https://github.com/django/django/pull/19758 PR]

It's an the right track, feel free to assign yourself and uncheck patch
needs improvement once comments have been addressed
--
Ticket URL: <https://code.djangoproject.com/ticket/35831#comment:11>

[Django]

#35831: Include ModelForm and its Meta options in reference docs
-------------------------------------+-------------------------------------

Reporter: jernwerber | Owner: Mustafa
Type: | Pirbhai

Cleanup/optimization | Status: assigned
Component: Documentation | Version:
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mustafa Pirbhai):

* owner: jernwerber => Mustafa Pirbhai

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

[Django]

#35831: Include ModelForm and its Meta options in reference docs

--------------------------------------+------------------------------------
Reporter: jernwerber | Owner: (none)
Type: Cleanup/optimization | Status: assigned

Component: Documentation | Version:
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by Mustafa Pirbhai):

* needs_better_patch: 1 => 0
* owner: Mustafa Pirbhai => (none)

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

[Django]

#35831: Include ModelForm and its Meta options in reference docs

-------------------------------------+-------------------------------------
Reporter: jernwerber | Owner: Mustafa
Type: | Pirbhai

Cleanup/optimization | Status: assigned
Component: Documentation | Version:
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Mustafa Pirbhai):

* owner: (none) => Mustafa Pirbhai

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

[Django]

#35831: Include ModelForm and its Meta options in reference docs
-------------------------------------+-------------------------------------
Reporter: jernwerber | Owner: Mustafa
Type: | Pirbhai
Cleanup/optimization | Status: assigned
Component: Documentation | Version:
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce):

* stage: Accepted => Ready for checkin

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

[Django]

#35831: Include ModelForm and its Meta options in reference docs
-------------------------------------+-------------------------------------
Reporter: jernwerber | Owner: Mustafa
Type: | Pirbhai

Cleanup/optimization | Status: closed
Component: Documentation | Version:
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce <42296566+sarahboyce@…>):

* resolution: => fixed
* status: assigned => closed

Comment:

In [changeset:"183fcebf88aa0762a2e28477f9b24c34341a75f4" 183fcebf]:
{{{#!CommitTicketReference repository=""
revision="183fcebf88aa0762a2e28477f9b24c34341a75f4"
Fixed #35831 -- Documented the model form meta API in model form reference
docs.

Co-authored-by: Jonathan <3218047+j...@users.noreply.github.com>
Co-authored-by: Mustafa <117516335...@users.noreply.github.com>
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35831#comment:16>

[Django]

#35831: Include ModelForm and its Meta options in reference docs
-------------------------------------+-------------------------------------
Reporter: jernwerber | Owner: Mustafa
Type: | Pirbhai
Cleanup/optimization | Status: closed
Component: Documentation | Version:
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Sarah Boyce <42296566+sarahboyce@…>):

In [changeset:"16a12a979989565f471ef1a2011bab59f8226f05" 16a12a9]:
{{{#!CommitTicketReference repository=""
revision="16a12a979989565f471ef1a2011bab59f8226f05"
[5.2.x] Fixed #35831 -- Documented the model form meta API in model form

reference docs.

Co-authored-by: Jonathan <3218047+j...@users.noreply.github.com>
Co-authored-by: Mustafa <117516335...@users.noreply.github.com>

Backport of 183fcebf88aa0762a2e28477f9b24c34341a75f4 from main.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35831#comment:17>