summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKarl O. Pinc <kop@meme.com>2013-10-07 21:00:26 -0500
committerKarl O. Pinc <kop@meme.com>2013-10-07 21:00:26 -0500
commit56170f30f6cd1d4268d9e5b0cd24a75c645ab0ca (patch)
treee7d9f1310794f40405ddc6f5a6f626dc13c9e10f /docs
parent13cf2dd2c912c1961d429c8a5756622cf960d5bf (diff)
downloadpyramid-56170f30f6cd1d4268d9e5b0cd24a75c645ab0ca.tar.gz
pyramid-56170f30f6cd1d4268d9e5b0cd24a75c645ab0ca.tar.bz2
pyramid-56170f30f6cd1d4268d9e5b0cd24a75c645ab0ca.zip
Docs: project.rst: Reword template reload note per Steve Piercy's suggestions.
Take care to retain the thought that the defaults setup by the scaffold cause automatic template reload. This patch should be applied before the docs_dict_note branch.
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/project.rst19
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 9451f41b1..0de46c806 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -886,15 +886,16 @@ returns the HTML in a :term:`response`.
See :ref:`views_which_use_a_renderer` for more information about how views,
renderers, and templates relate and cooperate.
-.. note:: Because our ``development.ini`` has a ``pyramid.reload_templates =
- true`` directive indicating that templates should be reloaded when
- they change, you won't need to restart the application server to
- see changes you make to templates. During development, this is
- handy. If this directive had been ``false`` (or if the directive
- did not exist), you would need to restart the application server
- for each template change. For production applications, you should
- set your project's ``pyramid.reload_templates`` to ``false`` to increase
- the speed at which templates may be rendered.
+.. note:: ``development.ini`` has a setting that controls how templates are
+ reloaded: ``pyramid.reload_templates``.
+
+ - A setting of ``True`` (as in the scaffold ``development.ini``)
+ automatically reloads changed templates without a server restart. This
+ is convenient while developing but slows template rendering speed.
+
+ - A setting of ``False`` (the default) requires a server restart to
+ integrate template changes. Production applications should set
+ ``pyramid.reload_templates = False``.
.. index::
single: static directory