classification
Title: Confusing documentation for urllib.urlopen
Type: Stage:
Components: Documentation Versions: Python 3.0, Python 2.6, Python 2.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, mark.dickinson
Priority: normal Keywords:

Created on 2008-03-14 15:47 by mark.dickinson, last changed 2008-03-14 23:10 by georg.brandl. This issue is now closed.

Messages (2)
msg63529 - (view) Author: Mark Dickinson (mark.dickinson) * (Python committer) Date: 2008-03-14 15:47
Grant Edwards pointed out in a comp.lang.python posting that the 
documentation for urlopen in the urllib module appears to be self-
contradictory:  at http://docs.python.org/dev/library/urllib.html
in the third-to-last paragraph for the urllib function, it says:

"Alternatively, the optional proxies argument may be used to explicitly 
specify proxies..."

and goes on to give examples.  Then the second-to-last paragraph seems 
to directly contradict this:

"The urlopen() function does not support explicit proxy specification. 
If you need to override environmental proxy settings, use URLopener, or 
a subclass such as FancyURLopener."

I suspect that this second paragraph should just be deleted in its 
entirety.
msg63541 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008-03-14 23:10
Thanks, fixed in r61392.
History
Date User Action Args
2008-03-14 23:10:54georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg63541
2008-03-14 16:10:52mark.dickinsonsettitle: Confusing documentation for urllip.urlopen -> Confusing documentation for urllib.urlopen
2008-03-14 15:47:46mark.dickinsoncreate