[docs] [issue18914] Confusing documentation in the urllib2 HOWTO

Brian Mingus report at bugs.python.org
Tue Sep 3 21:02:28 CEST 2013


Brian Mingus added the comment:

The documentation is confusing. Consider this comment:

# All calls to urllib2.urlopen will now use our handler
# Make sure not to include the protocol in with the URL, or
# HTTPPasswordMgrWithDefaultRealm will be very confused.
# You must (of course) use it when fetching the page though.

In the actual code he provides, he uses the protocol. Furthermore, before showing a simple way to use the libary, he shows a godawfully complex way. 

Either the documentation should made beautiful and comprehensible, or it should not be linked to.

----------

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


More information about the docs mailing list