diff options
| author | R David Murray <rdmurray@bitdance.com> | 2015-12-13 23:04:56 (GMT) |
|---|---|---|
| committer | R David Murray <rdmurray@bitdance.com> | 2015-12-13 23:04:56 (GMT) |
| commit | 51a4b22f9935f5419c7b32647369cd1b01373c74 (patch) | |
| tree | 877f728914ca2f68f3f1a411a1ce1d1cb0eba7f1 /Doc/library/binascii.rst | |
| parent | ed53782ed56df61a6437ee8c5c548d7955e85551 (diff) | |
| parent | 2b4f47ee35d945e3667abf3b081a15cf46d2c173 (diff) | |
| download | cpython-51a4b22f9935f5419c7b32647369cd1b01373c74.zip cpython-51a4b22f9935f5419c7b32647369cd1b01373c74.tar.gz cpython-51a4b22f9935f5419c7b32647369cd1b01373c74.tar.bz2 | |
Merge: #25495: Clarify b2a_base64 documentation vis 57 bytes.
Diffstat (limited to 'Doc/library/binascii.rst')
| -rw-r--r-- | Doc/library/binascii.rst | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/Doc/library/binascii.rst b/Doc/library/binascii.rst index b3b4aac..ff2bdda 100644 --- a/Doc/library/binascii.rst +++ b/Doc/library/binascii.rst @@ -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) @@ -167,7 +169,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. |