Opened 9 months ago
Last modified 9 months ago
#35072 closed Cleanup/optimization
Model docs Field.choices inconsistency between reference and topic guide — at Initial Version
| Reported by: | Zowie Beha | Owned by: | nobody |
|---|---|---|---|
| Component: | Documentation | Version: | 5.0 |
| Severity: | Normal | Keywords: | documentation, model, field |
| Cc: | Zowie Beha | Triage Stage: | Ready for checkin |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
https://docs.djangoproject.com/en/5.0/ref/models/fields/#django.db.models.Field.choices
On this reference page, Field.choices is described as:
"A mapping or iterable in the format described below to use as choices for this field."
https://docs.djangoproject.com/en/5.0/topics/db/models/#field-options
Here on the topic guide however, the description is:
"A sequence of 2-tuples to use as choices for this field."
I think this inconsistency is present because support for mappings as choices was introduced in Django 5.0, and the topic page hasn't yet been updated to reflect that change.
Note:
See TracTickets
for help on using tickets.