Opened 5 hours ago
Last modified 64 minutes ago
#35931 new Cleanup/optimization
Document fields and methods of the FlatPage model
| Reported by: | Baptiste Mispelon | Owned by: | |
|---|---|---|---|
| Component: | Documentation | Version: | 5.1 |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | no | 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
Note:
See TracTickets
for help on using tickets.