#6674 closed (fixed)
Missing widget documentation
Reported by: | Owned by: | holdenweb | |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Keywords: | ||
Cc: | Triage Stage: | Ready for checkin | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
In this thread:
http://groups.google.com/group/django-users/browse_thread/thread/14a89c7f23ae7225
SmileyChris mentions the render_value parameter that can be passed to the PasswordInput widget. Looking at the newforms doc on widgets:
http://www.djangoproject.com/documentation/newforms/#widgets
I can't see any mention of it, or (from a quick scan of the code) of the format parameter for a DateTimeInput, or of the check_test parameter to a CheckboxInput (not sure if that should be documented or is intended for internal use only?). The widget doc should probably be beefed up to include descriptions of these?
Attachments (2)
Change History (12)
comment:1 by , 17 years ago
Needs documentation: | set |
---|---|
Triage Stage: | Unreviewed → Accepted |
comment:2 by , 17 years ago
Owner: | changed from | to
---|
comment:3 by , 16 years ago
I'd say that treating them the way we already treat fields -- common arguments accepted by all widgets, then a list of widgets with notes for each one when it accepts extra arguments as well -- would be the way to do this.
comment:6 by , 16 years ago
Since the original ticket was opened, widgets are now documented on this page.
comment:7 by , 16 years ago
Has patch: | set |
---|---|
Needs documentation: | unset |
forma parameter in DateTimeInput has already been documented
comment:8 by , 15 years ago
Triage Stage: | Accepted → Ready for checkin |
---|
comment:9 by , 15 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
Should the widget types perhaps be shown as calls. It's not obvious where this information would go. Though the table of widgets seems like the logical place, this information wouldn't really fit in the existing tabular form. Perhaps I should discuss this on the dev list.