[Python-checkins] cpython (merge 3.3 -> default): Issue #17844: Add links to encoders and decoders for bytes-to-bytes codecs.

[serhiy.storchaka]

http://hg.python.org/cpython/rev/9afdd88fe33a
changeset:   83889:9afdd88fe33a
parent:      83885:155e6fb309f5
parent:      83888:039dc6dd2bc0
user:        Serhiy Storchaka <storchaka at gmail.com>
date:        Wed May 22 15:35:35 2013 +0300
summary:
  Issue #17844: Add links to encoders and decoders for bytes-to-bytes codecs.

files:
  Doc/library/codecs.rst |  52 +++++++++++++++---------------
  Misc/NEWS              |   3 +-
  2 files changed, 28 insertions(+), 27 deletions(-)


diff --git a/Doc/library/codecs.rst b/Doc/library/codecs.rst
--- a/Doc/library/codecs.rst
+++ b/Doc/library/codecs.rst
@@ -1188,33 +1188,33 @@
 
 The following codecs provide bytes-to-bytes mappings.
 
-.. tabularcolumns:: |l|L|
+.. tabularcolumns:: |l|L|L|
 
-+--------------------+---------------------------+
-| Codec              | Purpose                   |
-+====================+===========================+
-| base64_codec       | Convert operand to MIME   |
-|                    | base64 (the result always |
-|                    | includes a trailing       |
-|                    | ``'\n'``)                 |
-+--------------------+---------------------------+
-| bz2_codec          | Compress the operand      |
-|                    | using bz2                 |
-+--------------------+---------------------------+
-| hex_codec          | Convert operand to        |
-|                    | hexadecimal               |
-|                    | representation, with two  |
-|                    | digits per byte           |
-+--------------------+---------------------------+
-| quopri_codec       | Convert operand to MIME   |
-|                    | quoted printable          |
-+--------------------+---------------------------+
-| uu_codec           | Convert the operand using |
-|                    | uuencode                  |
-+--------------------+---------------------------+
-| zlib_codec         | Compress the operand      |
-|                    | using gzip                |
-+--------------------+---------------------------+
++--------------------+---------------------------+------------------------------+
+| Codec              | Purpose                   | Encoder/decoder              |
++====================+===========================+==============================+
+| base64_codec       | Convert operand to MIME   | :meth:`base64.b64encode`,    |
+|                    | base64 (the result always | :meth:`base64.b64decode`     |
+|                    | includes a trailing       |                              |
+|                    | ``'\n'``)                 |                              |
++--------------------+---------------------------+------------------------------+
+| bz2_codec          | Compress the operand      | :meth:`bz2.compress`,        |
+|                    | using bz2                 | :meth:`bz2.decompress`       |
++--------------------+---------------------------+------------------------------+
+| hex_codec          | Convert operand to        | :meth:`base64.b16encode`,    |
+|                    | hexadecimal               | :meth:`base64.b16decode`     |
+|                    | representation, with two  |                              |
+|                    | digits per byte           |                              |
++--------------------+---------------------------+------------------------------+
+| quopri_codec       | Convert operand to MIME   | :meth:`quopri.encodestring`, |
+|                    | quoted printable          | :meth:`quopri.decodestring`  |
++--------------------+---------------------------+------------------------------+
+| uu_codec           | Convert the operand using | :meth:`uu.encode`,           |
+|                    | uuencode                  | :meth:`uu.decode`            |
++--------------------+---------------------------+------------------------------+
+| zlib_codec         | Compress the operand      | :meth:`zlib.compress`,       |
+|                    | using gzip                | :meth:`zlib.decompress`      |
++--------------------+---------------------------+------------------------------+
 
 The following codecs provide string-to-string mappings.
 
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -327,10 +327,11 @@
 - Issue #17692: test_sqlite now works with unittest test discovery.
   Patch by Zachary Ware.
 
-
 Documentation
 -------------
 
+- Issue #17844: Add links to encoders and decoders for bytes-to-bytes codecs.
+
 - Issue #14097: improve the "introduction" page of the tutorial.
 
 - Issue #17977: The documentation for the cadefault argument's default value

-- 
Repository URL: http://hg.python.org/cpython