Opened 7 years ago

Closed 5 years ago

Last modified 4 years ago

#10027 closed (fixed)

include a link to "Form and Field Validation" from "Working with Forms"

Reported by: john_fries Owned by: gabrielhurley
Component: Documentation Version: 1.0
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

We should include a link to the "Form and Field Validation" document in the "further topics" section of the "Working with Forms" document (http://docs.djangoproject.com/en/dev/topics/forms/). I had a very hard time finding the "Form and Field Validation" material, and it's pretty essential to know about it when you are learning how to use Django forms.

Thanks,
John

Change History (5)

comment:1 Changed 7 years ago by john_fries

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

The "Form and Field Validation" document is at http://docs.djangoproject.com/en/dev/ref/forms/validation/

comment:2 Changed 6 years ago by timo

  • Triage Stage changed from Unreviewed to Design decision needed

I think the idea is that you would find that by following the "forms API reference" link under "see also". We probably don't want to duplicate the links in case they change in the future.

comment:3 Changed 5 years ago by gabrielhurley

  • milestone set to 1.3
  • Owner changed from nobody to gabrielhurley
  • Status changed from new to assigned
  • Triage Stage changed from Design decision needed to Accepted

I will say that it's not immediately evident where to click to get to the desired information when you're looking at the bottom of that page.

Looking at the code, "Further Topics" relates to other pages within this topic/directory in the Topics section of the docs, while "See Also" links to related information in other sections of the docs (in this in case the Reference section).

Simply duplicating links from one place to the other is not the answer, but a little work to clarify the bottom of this page would go a long way. I'll accept the ticket for that.

comment:4 Changed 5 years ago by gabrielhurley

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

(In [14112]) Fixed #10027 -- Makes links to form and field validation (and form reference docs in general) more readily available from form topic overview. Thanks to john_fries for the report.

comment:5 Changed 4 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

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