Opened 7 years ago

Closed 6 years ago

Last modified 6 years ago

#6674 closed (fixed)

Missing widget documentation

Reported by: Karen Tracey <kmtracey@…> Owned by: holdenweb
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

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)

widget-doc.diff (979 bytes) - added by timo 6 years ago.
documentation for render_doc and check_test
6674.diff (979 bytes) - added by timo 6 years ago.
update of patch to apply cleanly to trunk

Download all attachments as: .zip

Change History (12)

comment:1 Changed 7 years ago by SmileyChris

  • Needs documentation set
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 7 years ago by holdenweb

  • Owner changed from nobody to holdenweb

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.

comment:3 Changed 7 years ago by ubernostrum

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:4 Changed 7 years ago by kmtracey

#7801 asked for doc on render_value specifically.

comment:5 Changed 6 years ago by kmtracey

#10407 asked for render_value doc also.

comment:6 Changed 6 years ago by anonymous

Since the original ticket was opened, widgets are now documented on this page.

Changed 6 years ago by timo

documentation for render_doc and check_test

comment:7 Changed 6 years ago by timo

  • Has patch set
  • Needs documentation unset

forma parameter in DateTimeInput has already been documented

Changed 6 years ago by timo

update of patch to apply cleanly to trunk

comment:8 Changed 6 years ago by timo

  • Triage Stage changed from Accepted to Ready for checkin

comment:9 Changed 6 years ago by kmtracey

  • Resolution set to fixed
  • Status changed from new to closed

(In [11478]) Fixed #6674: Documented a couple of widget arguments. Thanks timo.

comment:10 Changed 6 years ago by kmtracey

(In [11479]) [1.0.X] Fixed #6674: Documented a couple of widget arguments. Thanks timo.

r11478 from trunk.

Note: See TracTickets for help on using tickets.
Back to Top