[Python-checkins] r76913 - python/branches/py3k/Doc/library/http.client.rst

[senthil.kumaran]

Author: senthil.kumaran
Date: Sun Dec 20 08:31:21 2009
New Revision: 76913

Log:
Document the headers parameter for set_tunnel.



Modified:
   python/branches/py3k/Doc/library/http.client.rst

Modified: python/branches/py3k/Doc/library/http.client.rst
==============================================================================
--- python/branches/py3k/Doc/library/http.client.rst	(original)
+++ python/branches/py3k/Doc/library/http.client.rst	Sun Dec 20 08:31:21 2009
@@ -386,11 +386,14 @@
 
    .. 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()