summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2010-11-01 01:09:03 -0400
committerChris McDonough <chrism@plope.com>2010-11-01 01:09:03 -0400
commitba471ceceb644b5d60c05a5ffa8216fb4ee8f730 (patch)
tree1dbd9132eedd03406b1da73892a7e3021bf69fed /docs/narr
parent3a2af35cc39ae4d656ed766cb255342d1abd3641 (diff)
downloadpyramid-ba471ceceb644b5d60c05a5ffa8216fb4ee8f730.tar.gz
pyramid-ba471ceceb644b5d60c05a5ffa8216fb4ee8f730.tar.bz2
pyramid-ba471ceceb644b5d60c05a5ffa8216fb4ee8f730.zip
document IRendererInfo in API docs
Diffstat (limited to 'docs/narr')
-rw-r--r--docs/narr/views.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/narr/views.rst b/docs/narr/views.rst
index e1983222d..fb500d914 100644
--- a/docs/narr/views.rst
+++ b/docs/narr/views.rst
@@ -744,7 +744,8 @@ following interface:
(the package that was 'current' at the time the renderer was
registered), ``type`` (the renderer type name), ``registry``
(the current application registry) and ``settings`` (the
- deployment settings dictionary)."""
+ deployment settings dictionary).
+ """
def __call__(self, value, system):
""" Call a the renderer implementation with the value and
@@ -754,6 +755,9 @@ following interface:
containing available system values (e.g. ``view``,
``context``, and ``request``). """
+The formal interface definition of the ``info`` object passed to a renderer
+factory constructor is available as :class:`pyramid.interfaces.IRendererInfo`.
+
There are essentially two different kinds of renderer factories:
- A renderer factory which expects to accept a :term:`resource specification`