Issue 19247: Describe surrogateescape algorithm in the Library Reference (original) (raw)

Issue19247

Created on 2013-10-13 14:12 by ncoghlan, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (3)
msg199707 - (view)	Author: Alyssa Coghlan (ncoghlan) *	Date: 2013-10-13 14:12
The codecs module currently refers out to PEP 383 as the documentation for the details of the ``surrogateescape`` error handler. Instead (as per the recent python-dev discussion about not using PEPs as substitutes for reference docs), there should be a section providing details on surrogateescape directly in the library reference for the codecs module. This may involve breaking out the current table of standard error handlers under its own heading rather than including it in the intro to codec base classes. Then the detailed description of surrogateescape could go under a dedicated subheading.
msg213402 - (view)	Author: R. David Murray (r.david.murray) *	Date: 2014-03-13 14:48
Looking at the PEP, I don't think there's anything in there that can just be copied to the docs. I've suggested to one of the new contributors to do the break out of the error handlers into its own section, and then someone with more understanding of surrogate escape and how we use it can write up the description for the sub-section.
msg240334 - (view)	Author: Alyssa Coghlan (ncoghlan) *	Date: 2015-04-09 14:59
The last round of updates to the codecs module docs covered the relevant details in the new error handlers section: https://docs.python.org/3/library/codecs.html#error-handlers