Opened 8 years ago

Closed 7 years ago

#4769 closed (fixed)

Unclear documentation in newforms

Reported by: crankycoder@… Owned by: nobody
Component: Documentation Version: master
Severity: Keywords: newforms
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Just above this link is some unnecessarily wordy text:

http://www.djangoproject.com/documentation/newforms/#as-p

"Each text label is surrounded in an HTML <label> tag, which points to
the appropriate form field via its id. Its id, in turn, is generated
by prepending 'id_' to the field name."

This is unnecessarily wordy and confusing to at least myself and another developer I've asked.

A clearer description would be:

"Each text label is surrounded in an HTML <label> tag, whose 'for'
attribute contains the id of the appropriate form field."

Change History (2)

comment:1 Changed 8 years ago by anonymous

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

comment:2 Changed 7 years ago by ubernostrum

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

The relevant section of the newforms documentation appears to have been edited since this ticket was opened, and no longer seems to be confusing. If you still have problems following it, please re-open this ticket with specific suggestions for the current documentation.

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