#25010: TEMPLATES settings documentation is either wrong or just confusing
---------------------------------+--------------------
     Reporter:  danielquinn      |      Owner:  nobody
         Type:  Bug              |     Status:  new
    Component:  Template system  |    Version:  1.8
     Severity:  Normal           |   Keywords:
 Triage Stage:  Unreviewed       |  Has patch:  0
Easy pickings:  0                |      UI/UX:  0
---------------------------------+--------------------
 The documentation for the `TEMPLATES` setting
 https://docs.djangoproject.com/en/1.8/ref/settings/#templates says that
 `APP_DIR` defines whether or not Django should source templates from the
 `templates` directory inside each app directory.  In the simple example
 given, `APP_DIR` is set to `True`, which is a little weird because this is
 the default setup you get when you run `startproject`.

 However, further down in the same section, the default for `APP_DIR` is
 defined as `False`, so when I first read this, I thought that I needed to
 use the example snippet to turn on what was already the default behaviour.
 It's all very confusing.

 To fix this, I think the best option would be to:

 * Document that the default for `APP_DIR` is True (unless this isn't the
 case and I'm missing something)
 * Modify the example to do something other than the default behaviour.
 This part isn't necessary, but coupled with the above problem, none of
 this makes sense on first reading.

--
Ticket URL: <https://code.djangoproject.com/ticket/25010>
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/054.60d9080178065f212fe6a03167a37859%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to