summaryrefslogtreecommitdiffstats
path: root/Include
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2010-11-20 13:44:41 (GMT)
committerGeorg Brandl <georg@python.org>2010-11-20 13:44:41 (GMT)
commitbab3378f365b97db1ce7a3d497b0e2b89fb5a577 (patch)
treee07e9552160e4cebe7142c9c9300bf08c451ad53 /Include
parentb6b74a71231f9a104efc72dd0b1dbfb58a3b1eac (diff)
downloadcpython-bab3378f365b97db1ce7a3d497b0e2b89fb5a577.zip
cpython-bab3378f365b97db1ce7a3d497b0e2b89fb5a577.tar.gz
cpython-bab3378f365b97db1ce7a3d497b0e2b89fb5a577.tar.bz2
#10439: document PyCodec C APIs.
Diffstat (limited to 'Include')
-rw-r--r--Include/codecs.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/Include/codecs.h b/Include/codecs.h
index c979e86..4ea934e 100644
--- a/Include/codecs.h
+++ b/Include/codecs.h
@@ -144,7 +144,7 @@ PyAPI_FUNC(PyObject *) PyCodec_StreamWriter(
/* Unicode encoding error handling callback registry API */
-/* Register the error handling callback function error under the name
+/* Register the error handling callback function error under the given
name. This function will be called by the codec when it encounters
unencodable characters/undecodable bytes and doesn't know the
callback name, when name is specified as the error parameter
@@ -152,8 +152,8 @@ PyAPI_FUNC(PyObject *) PyCodec_StreamWriter(
Return 0 on success, -1 on error */
PyAPI_FUNC(int) PyCodec_RegisterError(const char *name, PyObject *error);
-/* Lookup the error handling callback function registered under the
- name error. As a special case NULL can be passed, in which case
+/* Lookup the error handling callback function registered under the given
+ name. As a special case NULL can be passed, in which case
the error handling callback for "strict" will be returned. */
PyAPI_FUNC(PyObject *) PyCodec_LookupError(const char *name);
@@ -163,7 +163,7 @@ PyAPI_FUNC(PyObject *) PyCodec_StrictErrors(PyObject *exc);
/* ignore the unicode error, skipping the faulty input */
PyAPI_FUNC(PyObject *) PyCodec_IgnoreErrors(PyObject *exc);
-/* replace the unicode error with ? or U+FFFD */
+/* replace the unicode encode error with ? or U+FFFD */
PyAPI_FUNC(PyObject *) PyCodec_ReplaceErrors(PyObject *exc);
/* replace the unicode encode error with XML character references */