summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/ubinascii.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/library/ubinascii.rst')
-rw-r--r--docs/library/ubinascii.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/library/ubinascii.rst b/docs/library/ubinascii.rst
index 4931f90482..192d34514b 100644
--- a/docs/library/ubinascii.rst
+++ b/docs/library/ubinascii.rst
@@ -4,6 +4,8 @@
.. module:: ubinascii
:synopsis: binary/ASCII conversions
+|see_cpython_module| :mod:`python:binascii`.
+
This module implements conversions between binary data and various
encodings of it in ASCII form (in both directions).
@@ -17,7 +19,7 @@ Functions
.. admonition:: Difference to CPython
:class: attention
- If additional argument, `sep` is supplied, it is used as a separator
+ If additional argument, *sep* is supplied, it is used as a separator
between hexadecimal values.
.. function:: unhexlify(data)
@@ -27,8 +29,12 @@ Functions
.. function:: a2b_base64(data)
- Convert Base64-encoded data to binary representation. Returns bytes string.
+ Decode base64-encoded data, ignoring invalid characters in the input.
+ Conforms to `RFC 2045 s.6.8 <https://tools.ietf.org/html/rfc2045#section-6.8>`_.
+ Returns a bytes object.
.. function:: b2a_base64(data)
- Encode binary data in Base64 format. Returns string.
+ Encode binary data in base64 format, as in `RFC 3548
+ <https://tools.ietf.org/html/rfc3548.html>`_. Returns the encoded data
+ followed by a newline character, as a bytes object.