This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: Docs for BaseHandler.protocol_xxx methods are unclear
Type: Stage:
Components: Documentation Versions: Python 2.6
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, kjohnson
Priority: normal Keywords:

Created on 2008-10-21 11:09 by kjohnson, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg75023 - (view) Author: Kent Johnson (kjohnson) * Date: 2008-10-21 11:09
In the docs for urllib2.BaseHandler previous to Python 2.6, the names of
the protocol_xxx() methods were spelled with 'protocol' in italics to
indicate that it is a placeholder; the actual method name is e.g.

In the Python 2.6 docs this typographic distinction has been lost
so it is not so clear that e.g. protocol_open() is not an actual method.

I suggest either restoring the italics or using a spelling such as
<protocol>_open() for the method names. If this is difficult then the
body of the descriptions should be rewritten to make it clear that the
'given protocol' is indicated by the name of the method.
msg78698 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-01-01 11:54
Fixed in r68117.
Date User Action Args
2022-04-11 14:56:40adminsetgithub: 48406
2009-01-01 11:54:03georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg78698
2008-10-21 11:09:29kjohnsoncreate