[Python-checkins] cpython (merge 3.4 -> 3.5): Merge: #25495: Clarify b2a_base64 documentation vis 57 bytes.

[r.david.murray]

https://hg.python.org/cpython/rev/ea9951598bab
changeset:   99557:ea9951598bab
branch:      3.5
parent:      99552:39ce98d9b6b7
parent:      99556:3d5bf9bd15a3
user:        R David Murray <rdmurray at bitdance.com>
date:        Sun Dec 13 18:04:56 2015 -0500
summary:
  Merge: #25495: Clarify b2a_base64 documentation vis 57 bytes.

files:
  Doc/library/binascii.rst |  9 ++++++---
  1 files changed, 6 insertions(+), 3 deletions(-)


diff --git a/Doc/library/binascii.rst b/Doc/library/binascii.rst
--- a/Doc/library/binascii.rst
+++ b/Doc/library/binascii.rst
@@ -55,8 +55,10 @@
 .. function:: b2a_base64(data)
 
    Convert binary data to a line of ASCII characters in base64 coding. The return
-   value is the converted line, including a newline char. The length of *data*
-   should be at most 57 to adhere to the base64 standard.
+   value is the converted line, including a newline char.  The newline is
+   added because the original use case for this function was to feed it a
+   series of 57 byte input lines to get output lines that conform to the
+   MIME-base64 standard.  Otherwise the output conforms to :rfc:`3548`.
 
 
 .. function:: a2b_qp(data, header=False)
@@ -167,7 +169,8 @@
 .. seealso::
 
    Module :mod:`base64`
-      Support for base64 encoding used in MIME email messages.
+      Support for RFC compliant base64-style encoding in base 16, 32, 64,
+      and 85.
 
    Module :mod:`binhex`
       Support for the binhex format used on the Macintosh.

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