diff options
| author | Michael Merickel <michael@merickel.org> | 2015-02-07 02:39:30 -0600 |
|---|---|---|
| committer | Michael Merickel <michael@merickel.org> | 2015-02-07 02:39:30 -0600 |
| commit | 04f7542941149010f31d42ed729d6317ffa06239 (patch) | |
| tree | bc1934fa7d7b59b699d055dbcc57449d6e79242f /docs | |
| parent | 3279854b8ffc02593a604f84d0f72b8e7d4f24a8 (diff) | |
| parent | da5f5f9ea02c2c9830c7ae016547d2bedd0e0171 (diff) | |
| download | pyramid-04f7542941149010f31d42ed729d6317ffa06239.tar.gz pyramid-04f7542941149010f31d42ed729d6317ffa06239.tar.bz2 pyramid-04f7542941149010f31d42ed729d6317ffa06239.zip | |
Merge branch 'fix.response-factory-docs'
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/interfaces.rst | 3 | ||||
| -rw-r--r-- | docs/glossary.rst | 3 | ||||
| -rw-r--r-- | docs/narr/hooks.rst | 9 |
3 files changed, 11 insertions, 4 deletions
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst index a62976d8a..de2a664a4 100644 --- a/docs/api/interfaces.rst +++ b/docs/api/interfaces.rst @@ -56,6 +56,9 @@ Other Interfaces .. autointerface:: IRenderer :members: + .. autointerface:: IResponseFactory + :members: + .. autointerface:: IViewMapperFactory :members: diff --git a/docs/glossary.rst b/docs/glossary.rst index 911c22075..9c0ea8598 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -18,7 +18,8 @@ Glossary response factory An object which, provided a :term:`request` as a single positional - argument, returns a Pyramid-compatible response. + argument, returns a Pyramid-compatible response. See + :class:`pyramid.interfaces.IResponseFactory`. response An object returned by a :term:`view callable` that represents response diff --git a/docs/narr/hooks.rst b/docs/narr/hooks.rst index 17cae2c67..4fd7670b9 100644 --- a/docs/narr/hooks.rst +++ b/docs/narr/hooks.rst @@ -364,9 +364,12 @@ Whenever :app:`Pyramid` returns a response from a view it creates a object. The factory that :app:`Pyramid` uses to create a response object instance can be -changed by passing a ``response_factory`` argument to the constructor of the -:term:`configurator`. This argument can be either a callable or a -:term:`dotted Python name` representing a callable. +changed by passing a :class:`pyramid.interfaces.IResponseFactory` argument to +the constructor of the :term:`configurator`. This argument can be either a +callable or a :term:`dotted Python name` representing a callable. + +The factory takes a single positional argument, which is a :term:`Request` +object. The argument may be ``None``. .. code-block:: python :linenos: |