Document the headers parameter for set_tunnel.

84b731c7 · Senthil Kumaran · f6346ac2 · 84b731c7
Commit 84b731c7 authored Dec 20, 2009 by Senthil Kumaran
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 1 deletion

Doc/library/http.client.rst Doc/library/http.client.rst +4 -1

No files found.
--- 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()