Opened 3 days ago
Last modified 12 hours ago
#35831 assigned Cleanup/optimization
Include ModelForm and its Meta options in reference docs
| Reported by: | jernwerber | Owned by: | jernwerber |
|---|---|---|---|
| Component: | Documentation | Version: | |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | no | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
ModelForm and the use and structure of a Meta inner class to control what it outputs is covered mostly by way of a topic, Creating Forms from Models.
As a developer, it would be helpful to be able to have a consolidated reference for the complete set of possible Meta options (ModelFormOptions) that can be used with a ModelForm's Meta class in a single place, rather than having to infer options from other topics or check the Python source.
Change History (3)
comment:1 by , 3 days ago
| Owner: | set to |
|---|---|
| Status: | new → assigned |
comment:2 by , 12 hours ago
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:3 by , 12 hours ago
| Summary: | Reference page for ModelForm Meta and ModelFormOptions → Include ModelForm and its Meta options in reference docs |
|---|
Note:
See TracTickets
for help on using tickets.
Hi @jernwerber, and thanks for taking the time to create this ticket.
I agree. The reference for
ModelFormand theMetaoptions should be here. Although I'm not sure how much we should include there given most of the information is covered in the topic. I think we should start with the signatures, descriptions and the list of Meta options along with what they do.