Opened 7 years ago

Last modified 7 years ago

#28102 closed Cleanup/optimization

Document how to put the full path of the built-in widget directories in DIRS — at Version 1

Reported by: Richard Eames Owned by: nobody
Component: Documentation Version: 1.11
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: yes UI/UX: no

Description (last modified by Tim Graham)

The documentation for the ​DIRS template setting states that

This should be set to a list of strings that contain full paths to your template directories

However, the documentation for the ​TemplatesSetting class tells us:

Adding the built-in widgets templates directory (django/forms/templates or django/forms/jinja2) in DIRS of one of your template engines.

That is, it says to add a relative path to the DIRS setting, which contradicts the documentation for DIRS.

Change History (1)

comment:1 by Tim Graham, 7 years ago

Description: modified (diff)
Easy pickings: set
Summary: Contradictory documentation about DIRS and TemplatesSetting → Document how to put the full path of the built-in widget directories in DIRS
Triage Stage: Unreviewed → Accepted

The TemplatesSetting docs could be more explicit and include an example of how to compute the full path to Django's built-in widget directories. The same confusion was also raised in #28088.

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