summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSenthil Kumaran <orsenthil@gmail.com>2009-12-20 07:31:21 (GMT)
committerSenthil Kumaran <orsenthil@gmail.com>2009-12-20 07:31:21 (GMT)
commit7e5229c3abd6195a7dbca8a0da30dbd203212205 (patch)
tree1b917da113bf230196daf9b8c9f6b1e0842b7977
parent47fff87027dcf6493d177902b7d851a6582f76d0 (diff)
downloadcpython-7e5229c3abd6195a7dbca8a0da30dbd203212205.zip
cpython-7e5229c3abd6195a7dbca8a0da30dbd203212205.tar.gz
cpython-7e5229c3abd6195a7dbca8a0da30dbd203212205.tar.bz2
Document the headers parameter for set_tunnel.
-rw-r--r--Doc/library/http.client.rst5
1 files changed, 4 insertions, 1 deletions
diff --git a/Doc/library/http.client.rst b/Doc/library/http.client.rst
index 31a0a9a..7a6717b 100644
--- a/Doc/library/http.client.rst
+++ b/Doc/library/http.client.rst
@@ -386,11 +386,14 @@ HTTPConnection Objects
.. versionadded:: 3.1
-.. method:: HTTPConnection.set_tunnel(host, port=None)
+.. method:: HTTPConnection.set_tunnel(host, port=None, headers=None)
Set the host and the port for HTTP Connect Tunnelling. Normally used when it
is required to a HTTPS Connection through a proxy server.
+ The headers argument should be a mapping of extra HTTP headers to to sent
+ with the CONNECT request.
+
.. versionadded:: 3.2
.. method:: HTTPConnection.connect()