]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[Bug #1441864] Clarify description of 'data' argument
authorAndrew M. Kuchling <amk@amk.ca>
Sat, 3 Jun 2006 18:46:03 +0000 (18:46 +0000)
committerAndrew M. Kuchling <amk@amk.ca>
Sat, 3 Jun 2006 18:46:03 +0000 (18:46 +0000)
Doc/lib/liburllib2.tex

index 1973d51acada727695b6bb438de2dd3d0d146814..edb87c01dc8ea834ba8b2f6a0c3f2bc607dff32e 100644 (file)
@@ -18,11 +18,13 @@ The \module{urllib2} module defines the following functions:
 Open the URL \var{url}, which can be either a string or a \class{Request}
 object.
 
-\var{data} should be a string, which specifies additional data to
-send to the server. In HTTP requests, which are the only ones that
-support \var{data}, it should be a buffer in the format of
-\mimetype{application/x-www-form-urlencoded}, for example one returned
-from \function{urllib.urlencode()}.
+\var{data} may be a string specifying additional data to send to the
+server. Currently HTTP requests are the only ones that use \var{data};
+the HTTP request will be a POST instead of a GET when the \var{data}
+parameter is provided.  \var{data} should be a buffer in the standard
+\mimetype{application/x-www-form-urlencoded} format.  The
+\function{urllib.urlencode()} function takes a mapping or sequence of
+2-tuples and returns a string in this format.
 
 This function returns a file-like object with two additional methods: