Opened 10 months ago

Closed 4 months ago

Last modified 4 months ago

#35931 closed Cleanup/optimization (fixed)

Document fields and methods of the FlatPage model

Reported by: Baptiste Mispelon Owned by: Karol Alvarado
Component: Documentation Version: 5.1
Severity: Normal Keywords:
Cc: David Bogar Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

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

Change History (13)

comment:1 by Tim Graham, 10 months ago

Triage Stage: UnreviewedAccepted

comment:2 by Karol Alvarado, 10 months ago

Owner: set to Karol Alvarado
Status: newassigned

comment:3 by Karol Alvarado, 9 months ago

Has patch: set

I made a PR with a detailed FlatPage model reference https://github.com/django/django/pull/18867

comment:4 by Brock Smickley, 9 months ago

Triage Stage: AcceptedReady for checkin

comment:5 by Sarah Boyce, 9 months ago

Patch needs improvement: set
Triage Stage: Ready for checkinAccepted

comment:6 by Ahmed Nassar, 6 months ago

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!

comment:7 by Ahmed Nassar, 5 months ago

Last edited 5 months ago by Ahmed Nassar (previous) (diff)

comment:8 by Clifford Gama, 5 months ago

Hello, Ahmed, the owner already applied the suggested improvements but it seems they forgot to update the ticket status.

comment:9 by Karol Alvarado, 4 months ago

Patch needs improvement: unset

comment:10 by David Bogar, 4 months ago

Triage Stage: AcceptedReady for checkin

comment:11 by David Bogar, 4 months ago

Cc: David Bogar added

comment:12 by Sarah Boyce <42296566+sarahboyce@…>, 4 months ago

Resolution: fixed
Status: assignedclosed

In 0ee06c04:

Fixed #35931 -- Documented fields and methods of the FlatPage model.

Co-authored-by: Clifford Gama <53076065+cliff688@…>

comment:13 by Sarah Boyce <42296566+sarahboyce@…>, 4 months ago

In 231eb7ac:

[5.2.x] Fixed #35931 -- Documented fields and methods of the FlatPage model.

Co-authored-by: Clifford Gama <53076065+cliff688@…>

Backport of 0ee06c04e0256094270db3ffe8b5dafa6a8457a3 from main.

Note: See TracTickets for help on using tickets.
Back to Top