diff options
| author | Georg Brandl <georg@python.org> | 2010-11-23 07:54:19 (GMT) |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2010-11-23 07:54:19 (GMT) |
| commit | 5a9326502d3e728158116940212eb08198f53ee8 (patch) | |
| tree | 9941f4eaa5b76665dba43e5de2605f2254ae8014 /Doc/c-api/codec.rst | |
| parent | 5e438570cb8d7b64d71f1cb356df12edfec09dfe (diff) | |
| download | cpython-5a9326502d3e728158116940212eb08198f53ee8.zip cpython-5a9326502d3e728158116940212eb08198f53ee8.tar.gz cpython-5a9326502d3e728158116940212eb08198f53ee8.tar.bz2 | |
#10468: document Unicode exception creation and access functions.
Diffstat (limited to 'Doc/c-api/codec.rst')
| -rw-r--r-- | Doc/c-api/codec.rst | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/Doc/c-api/codec.rst b/Doc/c-api/codec.rst index 31a6bde..8207ae0 100644 --- a/Doc/c-api/codec.rst +++ b/Doc/c-api/codec.rst @@ -80,15 +80,13 @@ Registry API for Unicode encoding error handlers The callback gets a single argument, an instance of :exc:`UnicodeEncodeError`, :exc:`UnicodeDecodeError` or :exc:`UnicodeTranslateError` that holds information about the problematic - sequence of characters or bytes and their offset in the original string. The + sequence of characters or bytes and their offset in the original string (see + :ref:`unicodeexceptions` for functions to extract this information). The callback must either raise the given exception, or return a two-item tuple containing the replacement for the problematic sequence, and an integer giving the offset in the original string at which encoding/decoding should be resumed. - .. XXX once they are documented, link to PyUnicode*Error access functions - to show how to get at the exception properties - Return ``0`` on success, ``-1`` on error. .. c:function:: PyObject* PyCodec_LookupError(const char *name) |