diff options
| author | Andrew Kuchling <amk@amk.ca> | 2013-06-16 16:58:48 (GMT) |
|---|---|---|
| committer | Andrew Kuchling <amk@amk.ca> | 2013-06-16 16:58:48 (GMT) |
| commit | c7b6c50f29fac4971e7271ac649ee3b7ef3deac7 (patch) | |
| tree | 84ce5a8e35e7d3da929f85c9f025beb2ddc05d7a /Doc/library/codecs.rst | |
| parent | 893f2ffc7c8a110f069bb05c66e60632cc49cbef (diff) | |
| download | cpython-c7b6c50f29fac4971e7271ac649ee3b7ef3deac7.zip cpython-c7b6c50f29fac4971e7271ac649ee3b7ef3deac7.tar.gz cpython-c7b6c50f29fac4971e7271ac649ee3b7ef3deac7.tar.bz2 | |
Describe 'surrogateescape' in the documentation.
Also, improve some docstring descriptions of the 'errors' parameter.
Closes #14015.
Diffstat (limited to 'Doc/library/codecs.rst')
| -rw-r--r-- | Doc/library/codecs.rst | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst index 0d38253..e80fc3a 100644 --- a/Doc/library/codecs.rst +++ b/Doc/library/codecs.rst @@ -78,7 +78,11 @@ It defines the following functions: reference (for encoding only) * ``'backslashreplace'``: replace with backslashed escape sequences (for encoding only) - * ``'surrogateescape'``: replace with surrogate U+DCxx, see :pep:`383` + * ``'surrogateescape'``: on decoding, replace with code points in the Unicode + Private Use Area ranging from U+DC80 to U+DCFF. These private code + points will then be turned back into the same bytes when the + ``surrogateescape`` error handler is used when encoding the data. + (See :pep:`383` for more.) as well as any other error handling name defined via :func:`register_error`. |