#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: 1 |
UI/UX: 0 |
-------------------------------------+-------------------------------------
Changes (by julien):
* needs_better_patch: 0 => 1
Comment:
Excellent! Here are just a few minor remarks:
* Add a reference link to "see the documentation for the built-in Field
classes".
* Show the required imports in the "Setting arguments for widgets"
example.
* Add "code-block" directives to all examples.
* Add a tilda in front of the
`:class:'~django.forms.widgets.extras.SelectDateWidget'` reference so that
only `SelectDateWidget` gets displayed and to make it more digestible.
* Add double back-quotes around `years` in "the years attribute is set..."
(or use an :attr: clause).
* In the "Widgets with choices" section, can you add references to the
relevant widgets? "A couple of widgets deal with choices" is a bit vague.
--
Ticket URL: <https://code.djangoproject.com/ticket/16264#comment:5>
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.
