Message 190860 - Python tracker

➜

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.

Author	akuchling
Recipients	Jim.Jewett, akuchling, cvrebert, docs@python, ezio.melotti
Date	2013-06-09.16:05:28
SpamBayes Score	-1.0
Marked as misclassified	Yes
Message-id	<[email protected]>
In-reply-to

Content
Here's a proposed patch that touches the Sphinx documentation and a docstring in codecs.py. The text is slightly revised from my current revisions to the Unicode howto. help(open) says "See the documentation for codecs.register for a list of the permitted encoding error strings". This is strictly correct: the Sphinx documentation features this info. But help(codecs.register) doesn't; it's more helpful to look at help(codecs.Codec). So maybe the docstring for open() should say: "See help(codecs.Codec) for a list of the permitted..." instead.

Here's a proposed patch that touches the Sphinx documentation and a docstring in codecs.py.  The text is slightly revised from my current revisions to the Unicode howto.

help(open) says "See the documentation for codecs.register for a list of the permitted encoding error strings".  This is strictly correct: the Sphinx documentation features this info.  But help(codecs.register) doesn't; it's more helpful to look at help(codecs.Codec).  

So maybe the docstring for open() should say: "See help(codecs.Codec) for a list of the permitted..." instead.

History
Date	User	Action	Args
2013-06-09 16:05:28	akuchling	set	recipients: + akuchling, ezio.melotti, cvrebert, docs@python, Jim.Jewett
2013-06-09 16:05:28	akuchling	set	messageid: <[email protected]>
2013-06-09 16:05:28	akuchling	link	issue14015 messages
2013-06-09 16:05:28	akuchling	create