From: Senthil Kumaran <senthil@uthcode.com>
Date: Fri, 6 Sep 2013 04:42:38 +0000 (-0700)
Subject: Improve urlencode docstring. Patch by Brian Brazil.
X-Git-Tag: v3.4.0a2~20^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=324ae385fe225ce31ae3c9aacc4106948c54740e;p=python

Improve urlencode docstring. Patch by Brian Brazil.
---

diff --git a/Lib/urllib/parse.py b/Lib/urllib/parse.py
index abe5d0d868..9a2df41faf 100644
--- a/Lib/urllib/parse.py
+++ b/Lib/urllib/parse.py
@@ -728,7 +728,7 @@ def quote_from_bytes(bs, safe='/'):
     return ''.join([quoter(char) for char in bs])
 
 def urlencode(query, doseq=False, safe='', encoding=None, errors=None):
-    """Encode a sequence of two-element tuples or dictionary into a URL query string.
+    """Encode a dict or sequence of two-element tuples into a URL query string.
 
     If any values in the query arg are sequences and doseq is true, each
     sequence element is converted to a separate parameter.
@@ -737,9 +737,9 @@ def urlencode(query, doseq=False, safe='', encoding=None, errors=None):
     parameters in the output will match the order of parameters in the
     input.
 
-    The query arg may be either a string or a bytes type. When query arg is a
-    string, the safe, encoding and error parameters are sent the quote_plus for
-    encoding.
+    The components of a query arg may each be either a string or a bytes type.
+    When a component is a string, the safe, encoding and error parameters are
+    sent to the quote_plus function for encoding.
     """
 
     if hasattr(query, "items"):