Opened 3 weeks ago

Last modified 2 weeks ago

#37127 assigned Cleanup/optimization

Link to form templates in documentation

Reported by: Tim Schilling Owned by: Rickey Shideler
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

In the forms documentation, there are several references to the forms' templates from the perspective of needing to customize them. A next logical step is to reproduce that file and tweak it for a developer's own needs. We should consider adding links to the source code for these templates to make that reproduction a bit easier. Not every developer realizes they can search site-packages/django for the templates.

I'm proposing anywhere render a value like django/forms/field.html we add a source link.

This would involve 53 changes across the following files (this was a crude search and could be wrong):

  • docs/ref/forms/api.txt
  • docs/ref/forms/fields.txt
  • docs/ref/forms/renderers.txt
  • docs/ref/forms/widgets.txt
  • docs/topics/forms/index.txt
  • docs/topics/forms/formsets.txt

Change History (5)

comment:1 by Clifford Gama, 3 weeks ago

Triage Stage: Unreviewed → Accepted

comment:2 by Rickey Shideler, 3 weeks ago

Owner: set to Rickey Shideler
Status: new → assigned

comment:3 by Rickey Shideler, 3 weeks ago

Has patch: set

I've opened a PR for this ticket: ​https://github.com/django/django/pull/21381

comment:4 by Tim Schilling, 2 weeks ago

Patch needs improvement: set

comment:5 by Tim Schilling, 2 weeks ago

Patch needs improvement: unset
Note: See TracTickets for help on using tickets.
Back to Top