#28102: Document how to put the full path of the built-in widget directories in
DIRS
--------------------------------------+------------------------------------
Reporter: Richard Eames | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 1.11
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
Changes (by Tim Graham):
* easy: 0 => 1
* stage: Unreviewed => Accepted
Old description:
> The documentation for the
> [`DIRS`](https://docs.djangoproject.com/en/1.11/ref/templates/api/#the-
> dirs-option) 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`](https://docs.djangoproject.com/en/1.11/ref/forms/renderers/#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`.
New description:
The documentation for the
[https://docs.djangoproject.com/en/stable/ref/templates/api/#the-dirs-
option 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
[https://docs.djangoproject.com/en/stable/ref/forms/renderers/#templatessetting
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`.
--
Comment:
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/28102#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/066.72e601e0ac26a37bb4fc5a3af42e23ab%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
