]> granicus.if.org Git - python/commitdiff
Merged revisions 81645 via svnmerge from
authorSenthil Kumaran <orsenthil@gmail.com>
Wed, 2 Jun 2010 02:29:00 +0000 (02:29 +0000)
committerSenthil Kumaran <orsenthil@gmail.com>
Wed, 2 Jun 2010 02:29:00 +0000 (02:29 +0000)
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r81645 | senthil.kumaran | 2010-06-02 07:49:15 +0530 (Wed, 02 Jun 2010) | 3 lines

  Fix issue8788 - description of doseq parameter in urllib.urlencode
........

Doc/library/urllib.parse.rst

index 53d79e968ba6c14b553f6c4ce53ea8193d2dd066..455925ebdbf5121bfc8844b157e88cc23449a99e 100644 (file)
@@ -312,19 +312,21 @@ The :mod:`urllib.parse` module defines the following functions:
 
 .. function:: urlencode(query, doseq=False)
 
-   Convert a mapping object or a sequence of two-element tuples  to a "url-encoded"
-   string, suitable to pass to :func:`urlopen` above as the optional *data*
-   argument.  This is useful to pass a dictionary of form fields to a ``POST``
-   request.  The resulting string is a series of ``key=value`` pairs separated by
-   ``'&'`` characters, where both *key* and *value* are quoted using
-   :func:`quote_plus` above.  If the optional parameter *doseq* is present and
-   evaluates to true, individual ``key=value`` pairs are generated for each element
-   of the sequence. When a sequence of two-element tuples is used as the *query*
-   argument, the first element of each tuple is a key and the second is a value.
-   The order of parameters in the encoded string will match the order of parameter
-   tuples in the sequence. This module provides the functions
-   :func:`parse_qs` and :func:`parse_qsl` which are used to parse query strings
-   into Python data structures.
+   Convert a mapping object or a sequence of two-element tuples  to a
+   "url-encoded" string, suitable to pass to :func:`urlopen` above as the
+   optional *data* argument.  This is useful to pass a dictionary of form
+   fields to a ``POST`` request.  The resulting string is a series of
+   ``key=value`` pairs separated by ``'&'`` characters, where both *key* and
+   *value* are quoted using :func:`quote_plus` above. When a sequence of
+   two-element tuples is used as the *query* argument, the first element of
+   each tuple is a key and the second is a value. The value element in itself
+   can be a sequence and in that case, if the optional parameter *doseq* is
+   evaluates to *True*, individual ``key=value`` pairs separated by ``'&'``are
+   generated for each element of the value sequence for the key.  The order of
+   parameters in the encoded string will match the order of parameter tuples in
+   the sequence. This module provides the functions :func:`parse_qs` and
+   :func:`parse_qsl` which are used to parse query strings into Python data
+   structures.
 
 
 .. seealso::