diff options
| author | Chris McDonough <chrism@agendaless.com> | 2010-10-13 18:35:41 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2010-10-13 18:35:41 +0000 |
| commit | 5c7bdc471961fa6079d2b10330bd2d584cb6f35b (patch) | |
| tree | 534d1f93f22d3b63cf7010ecd08824cd6d530811 | |
| parent | e3be0426582a9478ac8a4bf1d543e314ea4c2b61 (diff) | |
| download | pyramid-5c7bdc471961fa6079d2b10330bd2d584cb6f35b.tar.gz pyramid-5c7bdc471961fa6079d2b10330bd2d584cb6f35b.tar.bz2 pyramid-5c7bdc471961fa6079d2b10330bd2d584cb6f35b.zip | |
point at request API docs
| -rw-r--r-- | docs/glossary.rst | 5 | ||||
| -rw-r--r-- | docs/narr/views.rst | 6 | ||||
| -rw-r--r-- | docs/narr/webob.rst | 3 |
3 files changed, 11 insertions, 3 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst index e3b46c1f6..5aa6c15de 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -7,8 +7,9 @@ Glossary :sorted: request - A ``WebOb`` request object. See :ref:`webob_chapter` for - information about request objects. + A ``WebOb`` request object. See :ref:`webob_chapter` (narrative) + and :ref:`request_module` (API documentation) for information + about request objects. request factory An object which, provided a WSGI environment as a single diff --git a/docs/narr/views.rst b/docs/narr/views.rst index ac726abcc..21c17da15 100644 --- a/docs/narr/views.rst +++ b/docs/narr/views.rst @@ -620,6 +620,9 @@ attribute to the request before returning a result: request.response_status = '404 Not Found' return {'URL':request.URL} +For more information on attributes of the request, see the API +documentation in :ref:`request_module`. + .. index:: single: renderer (adding) @@ -1009,7 +1012,8 @@ working with and storing bytestrings, :mod:`repoze.bfg` configures the values into Unicode from the UTF-8 character set implicitly. This implicit decoding happens when view code obtains form field values via the :term:`WebOb` ``request.params``, ``request.GET``, or -``request.POST`` APIs. +``request.POST`` APIs (see :ref:`request_module` for details about +these APIs). For example, let's assume that the following form page is served up to a browser client, and its ``action`` points at some :mod:`repoze.bfg` diff --git a/docs/narr/webob.rst b/docs/narr/webob.rst index 5d69efe51..7241b4ebc 100644 --- a/docs/narr/webob.rst +++ b/docs/narr/webob.rst @@ -98,6 +98,9 @@ instance, ``req.if_modified_since`` returns a `datetime <http://python.org/doc/current/lib/datetime-datetime.html>`_ object (or None if the header is was not provided). +.. note:: Full API documentation for the :mod:`repoze.bfg` request + object is available in :ref:`request_module`. + .. index:: single: request attributes (special) |