summaryrefslogtreecommitdiff
path: root/Modules
diff options
context:
space:
mode:
authorNick Coghlan <ncoghlan@gmail.com>2015-01-07 00:22:00 +1000
committerNick Coghlan <ncoghlan@gmail.com>2015-01-07 00:22:00 +1000
commitb9fdb7a452c2b6f7a628118b5f695bd061b62cc8 (patch)
tree724c4a77f635adc95e78674ce5f24e79aa391fae /Modules
parentfcfed1991382f9697df574fae4115a9f815adca0 (diff)
downloadcpython-git-b9fdb7a452c2b6f7a628118b5f695bd061b62cc8.tar.gz
Issue 19548: update codecs module documentation
- clarified the distinction between text encodings and other codecs - clarified relationship with builtin open and the io module - consolidated documentation of error handlers into one section - clarified type constraints of some behaviours - added tests for some of the new statements in the docs
Diffstat (limited to 'Modules')
-rw-r--r--Modules/_codecsmodule.c6
1 files changed, 3 insertions, 3 deletions
diff --git a/Modules/_codecsmodule.c b/Modules/_codecsmodule.c
index 11d376883d..2bd751a815 100644
--- a/Modules/_codecsmodule.c
+++ b/Modules/_codecsmodule.c
@@ -54,9 +54,9 @@ PyDoc_STRVAR(register__doc__,
"register(search_function)\n\
\n\
Register a codec search function. Search functions are expected to take\n\
-one argument, the encoding name in all lower case letters, and return\n\
-a tuple of functions (encoder, decoder, stream_reader, stream_writer)\n\
-(or a CodecInfo object).");
+one argument, the encoding name in all lower case letters, and either\n\
+return None, or a tuple of functions (encoder, decoder, stream_reader,\n\
+stream_writer) (or a CodecInfo object).");
static
PyObject *codec_register(PyObject *self, PyObject *search_function)