[issue11448] docs for HTTPConnection.set_tunnel are ambiguous

Michael Stahn report at bugs.python.org
Fri Feb 8 11:18:53 CET 2013


Michael Stahn added the comment:

I thought the same as Ryan when reading the API. The best way would have been to call "set_tunnel" -> "set_proxy" and to implement the behaviour you expect on this: setting a proxy. There are some more places at this code which are not quite clear eg:

def putheader(self, header, *values):
  """Send a request header line to the server.

Here the methodname "putheader" is ok but the documentation is misleading: this just adds a new header-line to the buffer, it won't send it directly. But that's the problem with naming in APIs: once it's in the code you won't get it changed that fast..

----------
nosy: +m1kes

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


More information about the Python-bugs-list mailing list