#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 , 10 months ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:2 by , 10 months ago
Owner: | set to |
---|---|
Status: | new → assigned |
comment:3 by , 9 months ago
Has patch: | set |
---|
comment:4 by , 9 months ago
Triage Stage: | Accepted → Ready for checkin |
---|
comment:5 by , 9 months ago
Patch needs improvement: | set |
---|---|
Triage Stage: | Ready for checkin → Accepted |
comment:6 by , 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:8 by , 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 , 4 months ago
Patch needs improvement: | unset |
---|
comment:10 by , 4 months ago
Triage Stage: | Accepted → Ready for checkin |
---|
comment:11 by , 4 months ago
Cc: | added |
---|
I made a PR with a detailed FlatPage model reference https://github.com/django/django/pull/18867