Skip to content

Commit

Permalink
python#25495: Clarify b2a_base64 documentation vis 57 bytes.
Browse files Browse the repository at this point in the history
  • Loading branch information
bitdancer committed Dec 13, 2015
1 parent abeb647 commit 2b4f47e
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions Doc/library/binascii.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 2b4f47e

Please sign in to comment.