summaryrefslogtreecommitdiffstats
path: root/Doc/library/base64.rst
diff options
context:
space:
mode:
authorMatthias Bussonnier <bussonniermatthias@gmail.com>2017-03-02 14:21:26 (GMT)
committerBerker Peksag <berker.peksag@gmail.com>2017-03-02 14:21:26 (GMT)
commitc643a967dd7d33ccefa5b61b38caf40b448057ce (patch)
treedbd3e5ea14a08efc58b5e30ba2e8a55346344604 /Doc/library/base64.rst
parent698845eba71f98d11671f2e1af6dac2f54a3751d (diff)
downloadcpython-c643a967dd7d33ccefa5b61b38caf40b448057ce.zip
cpython-c643a967dd7d33ccefa5b61b38caf40b448057ce.tar.gz
cpython-c643a967dd7d33ccefa5b61b38caf40b448057ce.tar.bz2
Add Python version since deprecation in base64 methods. (#33)
Allow developers to not have to either test on N Python versions or looked through multiple versions of the docs to know whether they can easily update.
Diffstat (limited to 'Doc/library/base64.rst')
-rw-r--r--Doc/library/base64.rst17
1 files changed, 13 insertions, 4 deletions
diff --git a/Doc/library/base64.rst b/Doc/library/base64.rst
index 080d9d7..ceecf17 100644
--- a/Doc/library/base64.rst
+++ b/Doc/library/base64.rst
@@ -237,14 +237,18 @@ The legacy interface:
.. function:: decodebytes(s)
- decodestring(s)
Decode the :term:`bytes-like object` *s*, which must contain one or more
lines of base64 encoded data, and return the decoded :class:`bytes`.
- ``decodestring`` is a deprecated alias.
.. versionadded:: 3.1
+.. function:: decodestring(s)
+
+ Deprecated alias of :func:`decodebytes`.
+
+ .. deprecated:: 3.1
+
.. function:: encode(input, output)
@@ -257,14 +261,19 @@ The legacy interface:
.. function:: encodebytes(s)
- encodestring(s)
Encode the :term:`bytes-like object` *s*, which can contain arbitrary binary
data, and return :class:`bytes` containing the base64-encoded data, with newlines
(``b'\n'``) inserted after every 76 bytes of output, and ensuring that
there is a trailing newline, as per :rfc:`2045` (MIME).
- ``encodestring`` is a deprecated alias.
+ .. versionadded:: 3.1
+
+.. function:: encodestring(s)
+
+ Deprecated alias of :func:`encodebytes`.
+
+ .. deprecated:: 3.1
An example usage of the module: