summaryrefslogtreecommitdiff
path: root/docs/user/quickstart.rst
diff options
context:
space:
mode:
authorDavid Pursehouse <david.pursehouse@gmail.com>2013-07-19 17:00:46 +0900
committerDavid Pursehouse <david.pursehouse@gmail.com>2013-07-19 17:14:59 +0900
commit07ad75ee043493809f95e22788e5f85e604f96d4 (patch)
treeca27ea7ca37e6a8c4a3e0759e00b92594cdaeccc /docs/user/quickstart.rst
parente4b41320e61454ee69f644e99065ab08cce01c8b (diff)
downloadpython-requests-07ad75ee043493809f95e22788e5f85e604f96d4.tar.gz
Fix #1322: Add note in docs about None not being sent as data
In the case: payload = {'key1': 'value1', 'key2': 'value2', 'key3': None} r = requests.get("http://httpbin.org", params=payload) the parameter `key3` will not be sent as a parameter in the URL. Mention this in the documentation.
Diffstat (limited to 'docs/user/quickstart.rst')
-rw-r--r--docs/user/quickstart.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/user/quickstart.rst b/docs/user/quickstart.rst
index 59d75ccb..660cdfa2 100644
--- a/docs/user/quickstart.rst
+++ b/docs/user/quickstart.rst
@@ -71,6 +71,9 @@ You can see that the URL has been correctly encoded by printing the URL::
>>> print r.url
u'http://httpbin.org/get?key2=value2&key1=value1'
+Note that any dictionary key whose value is ``None`` will not be added to the
+URL's query string.
+
Response Content
----------------