Opened 9 months ago

Last modified 9 months ago

#35072 closed Cleanup/optimization

Model docs Field.choices inconsistency between reference and topic guide — at Version 6

Reported by: Zowie Beha Owned by: Zowie Beha
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 (last modified by Zowie Beha)

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."

A mapping is used as an example in the topic guide, however it might be better to mention explicitly/upfront all valid choices values (such as callables for example).

Change History (6)

comment:1 by Zowie Beha, 9 months ago

Description: modified (diff)

comment:2 by Zowie Beha, 9 months ago

Description: modified (diff)

comment:3 by Zowie Beha, 9 months ago

Description: modified (diff)

comment:4 by Zowie Beha, 9 months ago

Cc: Zowie Beha added

comment:5 by Zowie Beha, 9 months ago

Owner: changed from nobody to Zowie Beha
Status: newassigned

comment:6 by Zowie Beha, 9 months ago

Description: modified (diff)
Note: See TracTickets for help on using tickets.
Back to Top