]> granicus.if.org Git - python/commitdiff
Document the headers parameter for set_tunnel.
authorSenthil Kumaran <orsenthil@gmail.com>
Sun, 20 Dec 2009 07:31:21 +0000 (07:31 +0000)
committerSenthil Kumaran <orsenthil@gmail.com>
Sun, 20 Dec 2009 07:31:21 +0000 (07:31 +0000)
Doc/library/http.client.rst

index 31a0a9a78ec2dc80d3eb0d948fe4163b41762cb2..7a6717b5cf8f7d267417bcfb2584d14b075c0456 100644 (file)
@@ -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()