[Django] #35931: Document fields and methods of the FlatPage model

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: 5.1 | Severity: Normal
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
The reference documentation for the `flatpages.FlatPage` model [1] says
it's a "standard Django model", but it seems to be missing documentation
for which fields and methods are defined on this model. There's a
`[source]` link so the information isn't too hard to find, but I think a
proper reference documentation would be better.

Compare for example with the documenation for `contrib.User` [2] which is
a lot more complete.

[1]
https://docs.djangoproject.com/en/dev/ref/contrib/flatpages/#django.contrib.flatpages.models.FlatPage
[2]
https://docs.djangoproject.com/en/dev/ref/contrib/auth/#django.contrib.auth.models.User
--
Ticket URL: <https://code.djangoproject.com/ticket/35931>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#35931: Document fields and methods of the FlatPage model

--------------------------------------+------------------------------------
Reporter: Baptiste Mispelon | Owner: (none)

Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 5.1

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

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

--------------------------------------+------------------------------------
Changes (by Tim Graham):

* stage: Unreviewed => Accepted

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

[Django]

#35931: Document fields and methods of the FlatPage model

-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: assigned

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

-------------------------------------+-------------------------------------
Changes (by Karol Alvarado):

* owner: (none) => Karol Alvarado
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:2>

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Karol Alvarado):

* has_patch: 0 => 1

Comment:

I made a PR with a detailed FlatPage model reference
https://github.com/django/django/pull/18867
--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:3>
Django <https://code.djangoproject.com/>
The web framework for perfectionists with deadlines.

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin

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

Changes (by Brock Smickley):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:4>

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:

Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 1

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

Changes (by Sarah Boyce):

* needs_better_patch: 0 => 1
* stage: Ready for checkin => Accepted

--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:5>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Ahmed Nassar):

Hi,
I’d love to contribute to this issue and improve the existing patch.
May I take over and work on the required improvements?
Thanks!
--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:6>

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Ahmed Nassar):

I will send my own PR.
--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:7>

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Clifford Gama):

Hello, Ahmed, the owner already applied the suggested improvements but it
seems they forgot to update the ticket status.
--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:8>

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

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

Changes (by Karol Alvarado):

* needs_better_patch: 1 => 0

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

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin

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

Changes (by David Bogar):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:10>

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by David Bogar):

* cc: David Bogar (added)

--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:11>

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado

Cleanup/optimization | Status: closed
Component: Documentation | Version: 5.1
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: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

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

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

Comment:

In [changeset:"0ee06c04e0256094270db3ffe8b5dafa6a8457a3" 0ee06c04]:
{{{#!CommitTicketReference repository=""
revision="0ee06c04e0256094270db3ffe8b5dafa6a8457a3"
Fixed #35931 -- Documented fields and methods of the FlatPage model.

Co-authored-by: Clifford Gama <53076065...@users.noreply.github.com>
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:12>

[Django]

#35931: Document fields and methods of the FlatPage model
-------------------------------------+-------------------------------------
Reporter: Baptiste Mispelon | Owner: Karol
Type: | Alvarado
Cleanup/optimization | Status: closed
Component: Documentation | Version: 5.1
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: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

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

In [changeset:"231eb7acc312096e631b8ca11abb4863ce8ea6df" 231eb7ac]:
{{{#!CommitTicketReference repository=""
revision="231eb7acc312096e631b8ca11abb4863ce8ea6df"
[5.2.x] Fixed #35931 -- Documented fields and methods of the FlatPage

model.

Co-authored-by: Clifford Gama <53076065...@users.noreply.github.com>

Backport of 0ee06c04e0256094270db3ffe8b5dafa6a8457a3 from main.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35931#comment:13>