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: Describe surrogateescape algorithm in the Library Reference
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.4
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, ezio.melotti, ncoghlan, r.david.murray
Priority: normal Keywords:

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: Nick Coghlan (ncoghlan) * (Python committer) 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) * (Python committer) 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: Nick Coghlan (ncoghlan) * (Python committer) 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:
Date User Action Args
2022-04-11 14:57:51adminsetgithub: 63446
2015-04-09 14:59:12ncoghlansetstatus: open -> closed
resolution: fixed
messages: + msg240334

stage: needs patch -> resolved
2014-03-13 14:48:22r.david.murraysetnosy: + r.david.murray
messages: + msg213402
2013-10-13 16:06:30georg.brandlsetassignee: docs@python

components: + Documentation
nosy: + docs@python
2013-10-13 15:09:14ezio.melottisetnosy: + ezio.melotti
2013-10-13 14:12:57ncoghlancreate