#28102 closed Cleanup/optimization (fixed)
Document how to put the full path of the built-in widget directories in DIRS
| Reported by: | no | Owned by: | Windson yang |
|---|---|---|---|
| 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 )
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
DIRSof 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 (6)
comment:1 by , 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 |
comment:2 by , 7 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
comment:3 by , 7 years ago
I pull request here https://github.com/django/django/pull/8513 but failed at doc test, any idea? Thanks.
comment:4 by , 7 years ago
| Has patch: | set |
|---|---|
| Patch needs improvement: | set |
Note:
See TracTickets
for help on using tickets.
The
TemplatesSettingdocs 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.