Commit 219336af authored by Walter Dörwald's avatar Walter Dörwald

Document that codecs.lookup() returns a CodecInfo object.

(fixes SF bug #1754453).
parent b68c944c
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
register(search_function) -> None register(search_function) -> None
lookup(encoding) -> (encoder, decoder, stream_reader, stream_writer) lookup(encoding) -> CodecInfo object
The builtin Unicode codecs use the following interface: The builtin Unicode codecs use the following interface:
...@@ -45,7 +45,8 @@ PyDoc_STRVAR(register__doc__, ...@@ -45,7 +45,8 @@ PyDoc_STRVAR(register__doc__,
\n\ \n\
Register a codec search function. Search functions are expected to take\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\ one argument, the encoding name in all lower case letters, and return\n\
a tuple of functions (encoder, decoder, stream_reader, stream_writer)."); a tuple of functions (encoder, decoder, stream_reader, stream_writer)\n\
(or a CodecInfo object).");
static static
PyObject *codec_register(PyObject *self, PyObject *search_function) PyObject *codec_register(PyObject *self, PyObject *search_function)
...@@ -57,10 +58,10 @@ PyObject *codec_register(PyObject *self, PyObject *search_function) ...@@ -57,10 +58,10 @@ PyObject *codec_register(PyObject *self, PyObject *search_function)
} }
PyDoc_STRVAR(lookup__doc__, PyDoc_STRVAR(lookup__doc__,
"lookup(encoding) -> (encoder, decoder, stream_reader, stream_writer)\n\ "lookup(encoding) -> CodecInfo\n\
\n\ \n\
Looks up a codec tuple in the Python codec registry and returns\n\ Looks up a codec tuple in the Python codec registry and returns\n\
a tuple of functions."); a tuple of function (or a CodecInfo object).");
static static
PyObject *codec_lookup(PyObject *self, PyObject *args) PyObject *codec_lookup(PyObject *self, PyObject *args)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment