#16264: Improve widget documentation
-------------------------------------+-------------------------------------
Reporter: | Owner: bpeschier
from_a_far@… | Status: new
Type: | Component: Documentation
Cleanup/optimization | Severity: Normal
Milestone: | Keywords: docs
Version: 1.3 | Has patch: 1
Resolution: | Needs tests: 0
Triage Stage: Accepted | Easy pickings: 1
Needs documentation: 0 |
Patch needs improvement: 0 |
UI/UX: 0 |
-------------------------------------+-------------------------------------
Comment (by julien):
Nice! I have few more small remarks:
* Can you add a tilda in front of `:attr:'~SelectDateWidget.years'`?
* The phrase "The reference below describes which options can be set."
feels a bit out of place. It would sit better under the `SimpleForm`
example, also including a link to the "Built-in widgets" section.
* Move the `date` field in `SimpleForm` to the top (i.e. above `radio` and
`checkboxes`) and rename it `year`, so that it's identifiable more
quickly.
* The "Widgets with choices" section could be made a little clearer. For
example, "Widgets inheriting from the Select widget" would sound clearer
than "Widgets based on the Select widget". Also "these are 'owned' by a
field" feels a bit confusing. It'd be nice to also clarify the
relationship between `ChoiceField` and and the `Select` widget (i.e.
when/how are they used together). A code sample might also help, if you
can add one.
Sorry to be so picky. Your patch is already really good and it's close to
be RFC.
Thanks! :)
--
Ticket URL: <https://code.djangoproject.com/ticket/16264#comment:7>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com.
To unsubscribe from this group, send email to
django-updates+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
