]> granicus.if.org Git - python/commitdiff
#25495: Clarify b2a_base64 documentation vis 57 bytes.
authorR David Murray <rdmurray@bitdance.com>
Sun, 13 Dec 2015 23:04:27 +0000 (18:04 -0500)
committerR David Murray <rdmurray@bitdance.com>
Sun, 13 Dec 2015 23:04:27 +0000 (18:04 -0500)
Doc/library/binascii.rst

index e3f134b53aca4c117b2a7f6ff7625db7a2f5c989..dbe535d94d181fb939e15fe2366c082a879d4f90 100644 (file)
@@ -55,8 +55,10 @@ The :mod:`binascii` module defines the following functions:
 .. 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)
@@ -168,7 +170,8 @@ The :mod:`binascii` module defines the following functions:
 .. 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.