Opened 18 years ago
Closed 18 years ago
#3455 closed (fixed)
Documentation for "choices" should mention "get_FOO_display"
Description ¶
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.
Change History (5)
comment:1 by , 18 years ago
Triage Stage: | Unreviewed → Accepted |
---|
by , 18 years ago
comment:2 by , 18 years ago
Triage Stage: | Accepted → Ready for checkin |
---|
comment:3 by , 18 years ago
Has patch: | set |
---|
comment:4 by , 18 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
Patch pointing out get_FOO_display in "choices" docs