summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-05-13 02:28:05 -0400
committerChris McDonough <chrism@plope.com>2011-05-13 02:28:05 -0400
commit2a1c3f740dfe3bb5f899cc4ccb2cf15461c5f950 (patch)
treedd0a520524e76c2bad68c0a5ebf05f23fa004cd4 /docs/api
parente85fd765056772974be9cbf8ee421da159fa0f6b (diff)
downloadpyramid-2a1c3f740dfe3bb5f899cc4ccb2cf15461c5f950.tar.gz
pyramid-2a1c3f740dfe3bb5f899cc4ccb2cf15461c5f950.tar.bz2
pyramid-2a1c3f740dfe3bb5f899cc4ccb2cf15461c5f950.zip
- Added documentation for a "multidict" (e.g. the API of ``request.POST``) as
interface API documentation.
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/interfaces.rst4
-rw-r--r--docs/api/request.rst6
2 files changed, 10 insertions, 0 deletions
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst
index 54afdc830..ac282fbcc 100644
--- a/docs/api/interfaces.rst
+++ b/docs/api/interfaces.rst
@@ -54,3 +54,7 @@ Other Interfaces
.. autointerface:: IViewMapper
:members:
+ .. autointerface:: IMultiDict
+ :members:
+
+
diff --git a/docs/api/request.rst b/docs/api/request.rst
index 639d0fcd8..8cb424658 100644
--- a/docs/api/request.rst
+++ b/docs/api/request.rst
@@ -177,3 +177,9 @@
(such as the status code, a header, the content type, etc) see,
:ref:`response_prefixed_attrs`.
+.. note::
+
+ For information about the API of a :term:`multidict` structure (such as
+ that used as ``request.GET``, ``request.POST``, and ``request.params``),
+ see :class:`pyramid.interfaces.IMultiDict`.
+