[New-bugs-announce] [issue11448] docs for HTTPConnection.set_tunnel are ambiguous

[Ryan Kelly]

New submission from Ryan Kelly <ryan at rfk.id.au>:

The docs for HTTPConnection.set_tunnel(host,port) are ambiguous.  They simply say "Set the host and the port for HTTP Connect Tunnelling".  But should I specify the address of the server *through* which I want to tunnel, or the address of the *endpoint* of the tunnel?

Turns out it's the latter, but I just wasted an hour "debugging" thinking it was the former :-(

Attached is a simple doc patch to try to clarify this issue.

----------
assignee: docs at python
components: Documentation
files: set_tunnel_doc.diff
keywords: patch
messages: 130396
nosy: docs at python, rfk
priority: normal
severity: normal
status: open
title: docs for HTTPConnection.set_tunnel are ambiguous
versions: Python 3.3
Added file: http://bugs.python.org/file21056/set_tunnel_doc.diff

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue11448>
_______________________________________