summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2012-01-19 03:24:04 -0500
committerChris McDonough <chrism@plope.com>2012-01-19 03:24:04 -0500
commit077f3d1d0b28d9f565cc07a3ad11f4a8bb359054 (patch)
tree09ac1c9fb803fc89a557eb7283452e526614232e /docs/api
parent4ef8a99d3260d99fa5522a0d26f1e7c1487c0265 (diff)
parent520676451b8b89177ad95cfcaa3f90484f5a6a18 (diff)
downloadpyramid-077f3d1d0b28d9f565cc07a3ad11f4a8bb359054.tar.gz
pyramid-077f3d1d0b28d9f565cc07a3ad11f4a8bb359054.tar.bz2
pyramid-077f3d1d0b28d9f565cc07a3ad11f4a8bb359054.zip
Merge branch '1.3-branch'
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/request.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/api/request.rst b/docs/api/request.rst
index 9596e5621..1ab84e230 100644
--- a/docs/api/request.rst
+++ b/docs/api/request.rst
@@ -208,9 +208,7 @@
body associated with this request, this property will raise an
exception. See also :ref:`request_json_body`.
- .. method:: set_property(func, name=None, reify=False)
-
- .. versionadded:: 1.3
+ .. method:: set_property(callable, name=None, reify=False)
Add a callable or a property descriptor to the request instance.
@@ -225,15 +223,15 @@
cached. Thus the value of the property is only computed once for
the lifetime of the object.
- ``func`` can either be a callable that accepts the request as
+ ``callable`` can either be a callable that accepts the request as
its single positional parameter, or it can be a property
descriptor.
- If the ``func`` is a property descriptor a ``ValueError`` will
- be raised if ``name`` is ``None`` or ``reify`` is ``True``.
+ If the ``callable`` is a property descriptor a ``ValueError``
+ will be raised if ``name`` is ``None`` or ``reify`` is ``True``.
If ``name`` is None, the name of the property will be computed
- from the name of the ``func``.
+ from the name of the ``callable``.
.. code-block:: python
:linenos:
@@ -259,6 +257,8 @@
without having to subclass it, which can be useful for extension
authors.
+ .. versionadded:: 1.3
+
.. note::
For information about the API of a :term:`multidict` structure (such as