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

index bf7e8ef57a4d59e5c06ae02f797fa7f0410536fc..d881968e48b6385356d4de3fc3f7c47d013cbd2e 100644 (file)
@@ -428,11 +428,14 @@ HTTPConnection Objects
    debug level is ``0``, meaning no debugging output is printed.
 
 
-.. 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 do HTTPS Conection through a proxy server.
 
+   The headers argument should be a mapping of extra HTTP headers to to sent
+   with the CONNECT request.
+
    .. versionadded:: 2.7