summaryrefslogtreecommitdiff
path: root/Doc/library/binascii.rst
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2015-12-13 18:11:07 -0500
committerR David Murray <rdmurray@bitdance.com>2015-12-13 18:11:07 -0500
commit69f0ce5672eeb73d073d7b3b7b4a6a6d65691375 (patch)
tree896d31d2306b896659581ae8a57293d0c708cea7 /Doc/library/binascii.rst
parentce9801e984ce2683029f79ed727620f1f712290d (diff)
parentb8d9114ebf804ac3562d229677b0d654fa329bd0 (diff)
downloadcpython-69f0ce5672eeb73d073d7b3b7b4a6a6d65691375.tar.gz
Merge: #25495: Clarify b2a_base64 documentation vis 57 bytes.
In 3.6 the parameter to control the appending of the newline was finally added, so I dropped the historical note about why a new line was always appended.
Diffstat (limited to 'Doc/library/binascii.rst')
-rw-r--r--Doc/library/binascii.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/Doc/library/binascii.rst b/Doc/library/binascii.rst
index ff2bddaf9d..632ecf7f0f 100644
--- a/Doc/library/binascii.rst
+++ b/Doc/library/binascii.rst
@@ -52,13 +52,14 @@ The :mod:`binascii` module defines the following functions:
than one line may be passed at a time.
-.. function:: b2a_base64(data)
+.. function:: b2a_base64(data, \*, newline=True)
Convert binary data to a line of ASCII characters in base64 coding. The return
- 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`.
+ value is the converted line, including a newline char if *newline* is
+ true. The output of this function conforms to :rfc:`3548`.
+
+ .. versionchanged:: 3.6
+ Added the *newline* parameter.
.. function:: a2b_qp(data, header=False)