From: Andrew M. Kuchling <amk@amk.ca>
Date: Sat, 3 Jun 2006 18:41:28 +0000 (+0000)
Subject: [Bug #1441864] Clarify description of 'data' argument
X-Git-Tag: v2.5b1~293
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=27ca711d205995977a72e112f993eadcaaa06472;p=python

[Bug #1441864] Clarify description of 'data' argument
---

diff --git a/Doc/lib/liburllib2.tex b/Doc/lib/liburllib2.tex
index f77ed25353..be36e3d307 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: