summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-08-20 22:31:36 -0400
committerChris McDonough <chrism@plope.com>2011-08-20 22:31:36 -0400
commit2cabb1335640488e39340b33959e5f0e8fa630d3 (patch)
treece7610ca1c3a9ea61545bd2855f28142b6133638 /docs
parent79ebb681ad5a866d98186a520922ecc9fe85340c (diff)
parent4f070b0887e43c6582a06e0e2c318a5c09962340 (diff)
downloadpyramid-2cabb1335640488e39340b33959e5f0e8fa630d3.tar.gz
pyramid-2cabb1335640488e39340b33959e5f0e8fa630d3.tar.bz2
pyramid-2cabb1335640488e39340b33959e5f0e8fa630d3.zip
Merge branch 'feature.no-tween-aliases'
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/hooks.rst33
1 files changed, 4 insertions, 29 deletions
diff --git a/docs/narr/hooks.rst b/docs/narr/hooks.rst
index df5339c8a..4afc0506b 100644
--- a/docs/narr/hooks.rst
+++ b/docs/narr/hooks.rst
@@ -930,10 +930,10 @@ tween in a Pyramid application:
Note that you must use a :term:`dotted Python name` as the first argument to
:meth:`pyramid.config.Configurator.add_tween`; this must point at a tween
factory. You cannot pass the tween factory object itself to the method: it
-must be a globally importable object. In the above example, we assume that a
-``timing_tween_factory`` tween factory was defined in a module named
-``myapp.tweens``, so the tween factory is importable as
-``myapp.tweens.timing_tween_factory``.
+must be :term:`dotted Python name` that points to a globally importable
+object. In the above example, we assume that a ``timing_tween_factory``
+tween factory was defined in a module named ``myapp.tweens``, so the tween
+factory is importable as ``myapp.tweens.timing_tween_factory``.
When you use :meth:`pyramid.config.Configurator.add_tween`, you're
instructing the system to use your tween factory at startup time unless the
@@ -993,9 +993,6 @@ Allowable values for ``under`` or ``over`` (or both) are:
predicted dotted name of a tween factory added in a call to ``add_tween``
in the same configuration session.
-- A "tween alias": a string representing the predicted value of ``alias`` in
- a separate call to ``add_tween`` in the same configuration session
-
- One of the constants :attr:`pyramid.tweens.MAIN`,
:attr:`pyramid.tweens.INGRESS`, or :attr:`pyramid.tweens.EXCVIEW`.
@@ -1063,28 +1060,6 @@ This constraint will require the tween to be located under both the
these is not in the current configuration, this constraint will only organize
itself based on the tweens that are present.
-:meth:`~pyramid.config.Configurator.add_tween` also accepts an ``alias``
-argument. If ``alias`` is not ``None``, should be a string. The string will
-represent a value that other callers of ``add_tween`` may pass as an
-``under`` and ``over`` argument instead of a dotted name to a tween factory.
-For example:
-
-.. code-block:: python
- :linenos:
-
- import pyramid.tweens
-
- config.add_tween('myapp.tween_factory1',
- alias='one'
- over=pyramid.tweens.MAIN)
- config.add_tween('myapp.tween_factory2',
- alias='two'
- over=pyramid.tweens.MAIN,
- under='one')
-
-Alias names are only useful in relation to ``under`` and ``over`` values.
-They cannot be used in explicit tween chain configuration, or anywhere else.
-
.. _explicit_tween_ordering:
Explicit Tween Ordering