From 6cb2b5b1e1ded4c10e305e493e016a7ccf0275cd Mon Sep 17 00:00:00 2001 From: Nick Coghlan Date: Mon, 14 Oct 2013 00:22:13 +1000 Subject: Issue #17827: Document codecs.encode and codecs.decode --- Doc/library/codecs.rst | 19 +++++++++++++++++++ Misc/NEWS | 3 +++ 2 files changed, 22 insertions(+) diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst index a5a27a2..004f5c7 100644 --- a/Doc/library/codecs.rst +++ b/Doc/library/codecs.rst @@ -22,6 +22,25 @@ manages the codec and error handling lookup process. It defines the following functions: +.. function:: encode(obj, encoding='utf-8', 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. + +.. function:: decode(obj, encoding='utf-8', 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. .. function:: register(search_function) diff --git a/Misc/NEWS b/Misc/NEWS index 536ea0e..e764376 100644 --- a/Misc/NEWS +++ b/Misc/NEWS @@ -76,6 +76,9 @@ Core and Builtins Library ------- +- Issue #17827: Add the missing documentation for ``codecs.encode`` and + ``codecs.decode``. + - Issue #18458: Prevent crashes with newer versions of libedit. Its readline emulation has changed from 0-based indexing to 1-based like gnu readline. Original patch by Ronald Oussoren. -- cgit v0.12