Documentation for "choices" should mention "get_FOO_display"
The documentation for the choices
attribute on model fields mentions that choices
should be a tuple of 2-tuples, including an actual value and a human-readable name, but documentation on how to retrieve the human-readable name of the selected choice from an instance of the model lives elsewhere, in the database API documentation, under the unintuitive name of get_FOO_display
. This hinders a new user of Django trying to understand how best to make use of choices
.
At the very least, the model documentation should include, under choices
, a link to the get_FOO_display
entry in the DB documentation for an explanation of how to get the human-readable name back out of a model instance. Ideally, we'd do that and come up with better titles for the sections on the various get_FOO_display
/get_next_by_FOO
/etc. methods.
Attachments
(1)
- 3455.diff
(792 bytes
) - added by James Bennett 18 years ago.
- Patch pointing out get_FOO_display in "choices" docs
Download all attachments as:
.zip
Change History
(5)
Triage Stage: |
Unreviewed → Accepted
|
Triage Stage: |
Accepted → Ready for checkin
|
Resolution: |
→ fixed
|
Status: |
new → closed
|
Patch pointing out get_FOO_display in "choices" docs