summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2014-05-25 21:27:09 -0400
committerChris McDonough <chrism@plope.com>2014-05-25 21:27:09 -0400
commit52e4b59f7264adc373bff4d1a96fd489991ecf8b (patch)
tree2e300de4c8adebc67ac1c26bdef9250abe82e28c /docs
parenta978083b5719faf13e2ccf98ae93d5b03ec0d7cb (diff)
parentc79c2d9f36f27abfa5e2a72e021298728734138d (diff)
downloadpyramid-52e4b59f7264adc373bff4d1a96fd489991ecf8b.tar.gz
pyramid-52e4b59f7264adc373bff4d1a96fd489991ecf8b.tar.bz2
pyramid-52e4b59f7264adc373bff4d1a96fd489991ecf8b.zip
Merge branch 'master' of github.com:Pylons/pyramid
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/hooks.rst8
-rw-r--r--docs/narr/templates.rst27
-rw-r--r--docs/quick_tutorial/databases.rst2
3 files changed, 22 insertions, 15 deletions
diff --git a/docs/narr/hooks.rst b/docs/narr/hooks.rst
index f2542f1d7..4da36e730 100644
--- a/docs/narr/hooks.rst
+++ b/docs/narr/hooks.rst
@@ -985,7 +985,7 @@ Creating a Tween
To create a tween, you must write a "tween factory". A tween factory
must be a globally importable callable which accepts two arguments:
-``handler`` and ``registry``. ``handler`` will be the either the main
+``handler`` and ``registry``. ``handler`` will be either the main
Pyramid request handling function or another tween. ``registry`` will be the
Pyramid :term:`application registry` represented by this Configurator. A
tween factory must return the tween (a callable object) when it is called.
@@ -1023,7 +1023,7 @@ method:
:linenos:
class simple_tween_factory(object):
- def __init__(handler, registry):
+ def __init__(self, handler, registry):
self.handler = handler
self.registry = registry
@@ -1040,6 +1040,10 @@ method:
return response
+You should avoid mutating any state on the tween instance. The tween is
+invoked once per request and any shared mutable state needs to be carefully
+handled to avoid any race conditions.
+
The closure style performs slightly better and enables you to conditionally
omit the tween from the request processing pipeline (see the following timing
tween example), whereas the class style makes it easier to have shared mutable
diff --git a/docs/narr/templates.rst b/docs/narr/templates.rst
index 038dd2594..460cda8ee 100644
--- a/docs/narr/templates.rst
+++ b/docs/narr/templates.rst
@@ -450,21 +450,24 @@ Available Add-On Template System Bindings
The Pylons Project maintains several packages providing bindings to different
templating languages including the following:
-+------------------------------+------------------------------+
-| Template Language | Pyramid Bindings |
-+==============================+==============================+
-| Chameleon_ | pyramid_chameleon_ |
-+------------------------------+------------------------------+
-| Jinja2_ | pyramid_jinja2_ |
-+------------------------------+------------------------------+
-| Mako_ | pyramid_mako_ |
-+------------------------------+------------------------------+
++---------------------------+----------------------------+--------------------+
+| Template Language | Pyramid Bindings | Default Extensions |
++===========================+============================+====================+
+| Chameleon_ | pyramid_chameleon_ | .pt, .txt |
++---------------------------+----------------------------+--------------------+
+| Jinja2_ | pyramid_jinja2_ | .jinja2 |
++---------------------------+----------------------------+--------------------+
+| Mako_ | pyramid_mako_ | .mak, .mako |
++---------------------------+----------------------------+--------------------+
.. _Chameleon: http://chameleon.readthedocs.org/en/latest/
-.. _pyramid_chameleon: https://pypi.python.org/pypi/pyramid_chameleon
+.. _pyramid_chameleon:
+ http://docs.pylonsproject.org/projects/pyramid-chameleon/en/latest/
.. _Jinja2: http://jinja.pocoo.org/docs/
-.. _pyramid_jinja2: https://pypi.python.org/pypi/pyramid_jinja2
+.. _pyramid_jinja2:
+ http://docs.pylonsproject.org/projects/pyramid-jinja2/en/latest/
.. _Mako: http://www.makotemplates.org/
-.. _pyramid_mako: https://pypi.python.org/pypi/pyramid_mako
+.. _pyramid_mako:
+ http://docs.pylonsproject.org/projects/pyramid-mako/en/latest/
diff --git a/docs/quick_tutorial/databases.rst b/docs/quick_tutorial/databases.rst
index 20b3cd46d..7c019dbfc 100644
--- a/docs/quick_tutorial/databases.rst
+++ b/docs/quick_tutorial/databases.rst
@@ -115,7 +115,7 @@ Steps
.. code-block:: bash
- $ $VENV/bin/nosetests .
+ $ $VENV/bin/nosetests tutorial
..
-----------------------------------------------------------------
Ran 2 tests in 1.141s