summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorAndrew M. Kuchling <amk@amk.ca>2006-06-03 18:41:28 (GMT)
committerAndrew M. Kuchling <amk@amk.ca>2006-06-03 18:41:28 (GMT)
commit27ca711d205995977a72e112f993eadcaaa06472 (patch)
tree342461af3bf7a0d76b9cc59a2823ebc64857c0fd /Doc
parent794c89b678b7409ec86f2b66bd0a11fec329d93e (diff)
downloadcpython-27ca711d205995977a72e112f993eadcaaa06472.zip
cpython-27ca711d205995977a72e112f993eadcaaa06472.tar.gz
cpython-27ca711d205995977a72e112f993eadcaaa06472.tar.bz2
[Bug #1441864] Clarify description of 'data' argument
Diffstat (limited to 'Doc')
-rw-r--r--Doc/lib/liburllib2.tex12
1 files changed, 7 insertions, 5 deletions
diff --git a/Doc/lib/liburllib2.tex b/Doc/lib/liburllib2.tex
index f77ed25..be36e3d 100644
--- a/Doc/lib/liburllib2.tex
+++ b/Doc/lib/liburllib2.tex
@@ -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} should be a string, which specifies additional data to send
+to the server. Currently HTTP requests are the only ones that use
+\var{data}. For HTTP, the 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: