Marked up a few raw values in the settings documentation.

This commit is contained in:
Simon Meers 2012-08-16 10:13:28 +10:00
parent e38112d882
commit d1d514af04
1 changed files with 8 additions and 7 deletions

View File

@ -747,14 +747,15 @@ Did you catch that? NEVER deploy a site into production with :setting:`DEBUG`
turned on. turned on.
One of the main features of debug mode is the display of detailed error pages. One of the main features of debug mode is the display of detailed error pages.
If your app raises an exception when ``DEBUG`` is ``True``, Django will display If your app raises an exception when :setting:`DEBUG` is ``True``, Django will
a detailed traceback, including a lot of metadata about your environment, such display a detailed traceback, including a lot of metadata about your
as all the currently defined Django settings (from ``settings.py``). environment, such as all the currently defined Django settings (from
``settings.py``).
As a security measure, Django will *not* include settings that might be As a security measure, Django will *not* include settings that might be
sensitive (or offensive), such as ``SECRET_KEY`` or ``PROFANITIES_LIST``. sensitive (or offensive), such as :setting:`SECRET_KEY` or
Specifically, it will exclude any setting whose name includes any of the :setting:`PROFANITIES_LIST`. Specifically, it will exclude any setting whose
following: name includes any of the following:
* API * API
* KEY * KEY
@ -1356,7 +1357,7 @@ MANAGERS
Default: ``()`` (Empty tuple) Default: ``()`` (Empty tuple)
A tuple in the same format as :setting:`ADMINS` that specifies who should get A tuple in the same format as :setting:`ADMINS` that specifies who should get
broken-link notifications when ``SEND_BROKEN_LINK_EMAILS=True``. broken-link notifications when :setting:`SEND_BROKEN_LINK_EMAILS` is ``True``.
.. setting:: MEDIA_ROOT .. setting:: MEDIA_ROOT