Opened 4 weeks ago
Last modified 3 weeks ago
#35931 assigned Cleanup/optimization
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: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | yes |
| 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 (5)
comment:1 by , 4 weeks ago
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:2 by , 4 weeks ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
comment:3 by , 3 weeks ago
| Has patch: | set |
|---|
comment:4 by , 3 weeks ago
| Triage Stage: | Accepted → Ready for checkin |
|---|
comment:5 by , 3 weeks ago
| Patch needs improvement: | set |
|---|---|
| Triage Stage: | Ready for checkin → Accepted |
Note:
See TracTickets
for help on using tickets.
I made a PR with a detailed FlatPage model reference https://github.com/django/django/pull/18867