From 6a98749e9c7b3917b01f2f47267e134ecd1c2df1 Mon Sep 17 00:00:00 2001 From: Nick Coghlan Date: Mon, 4 Nov 2013 20:05:16 +1000 Subject: [PATCH] Close #17827: Document codecs.encode & codecs.decode --- Doc/library/codecs.rst | 23 +++++++++++++++++++++++ Misc/NEWS | 4 ++++ 2 files changed, 27 insertions(+) diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst index 829be68155..f0e179b65b 100644 --- a/Doc/library/codecs.rst +++ b/Doc/library/codecs.rst @@ -23,6 +23,29 @@ manages the codec and error handling lookup process. It defines the following functions: +.. function:: encode(obj, encoding='ascii', errors='strict') + + Encodes *obj* using the codec registered for *encoding*. + + *Errors* may be given to set the desired error handling scheme. The + default error handler is ``strict`` meaning that encoding errors raise + :exc:`ValueError` (or a more codec specific subclass, such as + :exc:`UnicodeEncodeError`). Refer to :ref:`codec-base-classes` for more + information on codec error handling. + + .. versionadded:: 2.4 + +.. function:: decode(obj, encoding='ascii', errors='strict') + + Decodes *obj* using the codec registered for *encoding*. + + *Errors* may be given to set the desired error handling scheme. The + default error handler is ``strict`` meaning that decoding errors raise + :exc:`ValueError` (or a more codec specific subclass, such as + :exc:`UnicodeDecodeError`). Refer to :ref:`codec-base-classes` for more + information on codec error handling. + + .. versionadded:: 2.4 .. function:: register(search_function) diff --git a/Misc/NEWS b/Misc/NEWS index 9de6aafbb5..98efc56027 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -12,9 +12,13 @@ Core and Builtins Library ------- +- Issue #17827: Add the missing documentation for ``codecs.encode`` and + ``codecs.decode``. + - Issue #6157: Fixed Tkinter.Text.debug(). Original patch by Guilherme Polo. - Issue #6160: The bbox() method of tkinter.Spinbox now returns a tuple of + integers instead of a string. Based on patch by Guilherme Polo. - Issue #19286: Directories in ``package_data`` are no longer added to -- 2.50.1