diff options
| author | Michael Merickel <michael@merickel.org> | 2012-01-11 02:04:22 -0600 |
|---|---|---|
| committer | Michael Merickel <michael@merickel.org> | 2012-01-11 02:05:06 -0600 |
| commit | 1b113f772b48862c99e8269ca59365bc2acff85c (patch) | |
| tree | c9a5d38dbefcf0414395384bb128c141fda04e60 /docs/api/request.rst | |
| parent | cf3a11e990adda800e284effb006f1c28335da4d (diff) | |
| download | pyramid-1b113f772b48862c99e8269ca59365bc2acff85c.tar.gz pyramid-1b113f772b48862c99e8269ca59365bc2acff85c.tar.bz2 pyramid-1b113f772b48862c99e8269ca59365bc2acff85c.zip | |
Renamed the func to callable in the docs.
Diffstat (limited to 'docs/api/request.rst')
| -rw-r--r-- | docs/api/request.rst | 14 |
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 |
