summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBert JW Regeer <bertjw@regeer.org>2017-11-20 14:19:00 -0700
committerBert JW Regeer <bertjw@regeer.org>2017-11-20 14:51:48 -0700
commit7bbfc14809eac9c9134083b3f657580d33b4f533 (patch)
tree20c54ba9e97b92c3e366d0d2ee251e339dde56a1
parenta750188f3fb985188ecce5e1a694a2f2f7704ae1 (diff)
downloadwebob-7bbfc14809eac9c9134083b3f657580d33b4f533.tar.gz
Add information about MultiDict to the multidict API docs
-rw-r--r--docs/api/multidict.txt22
-rw-r--r--docs/index.txt23
2 files changed, 22 insertions, 23 deletions
diff --git a/docs/api/multidict.txt b/docs/api/multidict.txt
index 77f158b..1271b3d 100644
--- a/docs/api/multidict.txt
+++ b/docs/api/multidict.txt
@@ -1,6 +1,28 @@
:mod:`webob.multidict` -- multi-value dictionary object
=======================================================
+multidict
+---------
+
+Several parts of WebOb use a "multidict", which is a dictionary where a key can
+have multiple values. The quintessential example is a query string like
+``?pref=red&pref=blue``. The ``pref`` variable has two values, ``red`` and
+``blue``.
+
+In a multidict, when you do ``request.GET['pref']``, you'll get back only
+``'blue'`` (the last value of ``pref``). Sometimes returning a string and
+other times returning a list is a cause of frequent exceptions. If you want
+*all* the values back, use ``request.GET.getall('pref')``. If you want to be
+sure there is *one and only one* value, use ``request.GET.getone('pref')``,
+which will raise an exception if there is zero or more than one value for
+``pref``.
+
+When you use operations like ``request.GET.items()``, you'll get back something
+like ``[('pref', 'red'), ('pref', 'blue')]``. All the key/value pairs will
+show up. Similarly ``request.GET.keys()`` returns ``['pref', 'pref']``.
+Multidict is a view on a list of tuples; all the keys are ordered, and all the
+values are ordered.
+
.. automodule:: webob.multidict
.. autoclass:: MultiDict
:members:
diff --git a/docs/index.txt b/docs/index.txt
index 3f5376f..a5f15dd 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -277,29 +277,6 @@ You can use this like:
except HTTPException, e:
return e(environ, start_response)
-Multidict
-=========
-
-Several parts of WebOb use a "multidict", which is a dictionary where a
-key can have multiple values. The quintessential example is a query
-string like ``?pref=red&pref=blue``. The ``pref`` variable has two
-values, ``red`` and ``blue``.
-
-In a multidict, when you do ``request.GET['pref']``, you'll get back
-only ``'blue'`` (the last value of ``pref``). Sometimes returning a
-string and other times returning a list is a cause of frequent
-exceptions. If you want *all* the values back, use
-``request.GET.getall('pref')``. If you want to be sure there is *one
-and only one* value, use ``request.GET.getone('pref')``, which will
-raise an exception if there is zero or more than one value for
-``pref``.
-
-When you use operations like ``request.GET.items()``, you'll get back
-something like ``[('pref', 'red'), ('pref', 'blue')]``. All the
-key/value pairs will show up. Similarly ``request.GET.keys()``
-returns ``['pref', 'pref']``. Multidict is a view on a list of
-tuples; all the keys are ordered, and all the values are ordered.
-
Example
=======