[docs] [issue14015] surrogateescape largely missing from documentation

A.M. Kuchling report at bugs.python.org
Sun Jun 9 18:05:28 CEST 2013

A.M. Kuchling added the comment:

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.

Added file: http://bugs.python.org/file30514/patch14015.txt

Python tracker <report at bugs.python.org>

More information about the docs mailing list