From: Senthil Kumaran <orsenthil@gmail.com>
Date: Sun, 20 Dec 2009 07:29:31 +0000 (+0000)
Subject: Document the headers parameter for set_tunnel.
X-Git-Tag: v2.7a2~150
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0732fd952baf34eb0636fd6ce4c7093d2d70e98b;p=python

Document the headers parameter for set_tunnel.
---

diff --git a/Doc/library/httplib.rst b/Doc/library/httplib.rst
index bf7e8ef57a..d881968e48 100644
--- a/Doc/library/httplib.rst
+++ b/Doc/library/httplib.rst
@@ -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