summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntoine Pitrou <antoine@python.org>2020-05-01 19:54:44 (GMT)
committerGitHub <noreply@github.com>2020-05-01 19:54:44 (GMT)
commite05828055e5165cc7268ea3bea33adc502e054a1 (patch)
treedfd60cebfbfe8a97ffc2086910ab2f357708b715
parentc9d7d32b6dc6140f7fcbf1ae1120df6d59fc28d0 (diff)
downloadcpython-e05828055e5165cc7268ea3bea33adc502e054a1.zip
cpython-e05828055e5165cc7268ea3bea33adc502e054a1.tar.gz
cpython-e05828055e5165cc7268ea3bea33adc502e054a1.tar.bz2
[3.8] bpo-39435: Fix docs for pickle.loads (GH-18160) (GH-19843)
(cherry picked from commit 289842a) Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com> Automerge-Triggered-By: @pitrou
-rw-r--r--Doc/library/pickle.rst4
-rw-r--r--Misc/ACKS1
-rw-r--r--Misc/NEWS.d/next/Documentation/2020-01-24-05-42-57.bpo-39435.EFcdFU.rst1
3 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst
index a7b92bb..d92e947 100644
--- a/Doc/library/pickle.rst
+++ b/Doc/library/pickle.rst
@@ -252,10 +252,10 @@ process more convenient:
.. versionchanged:: 3.8
The *buffers* argument was added.
-.. function:: loads(bytes_object, \*, fix_imports=True, encoding="ASCII", errors="strict", buffers=None)
+.. function:: loads(data, \*, fix_imports=True, encoding="ASCII", errors="strict", buffers=None)
Return the reconstituted object hierarchy of the pickled representation
- *bytes_object* of an object.
+ *data* of an object. *data* must be a :term:`bytes-like object`.
The protocol version of the pickle is detected automatically, so no
protocol argument is needed. Bytes past the pickled representation
diff --git a/Misc/ACKS b/Misc/ACKS
index 9d8c0f9..34a6fc4 100644
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -769,6 +769,7 @@ Manuel Jacob
David Jacobs
Kevin Jacobs
Kjetil Jacobsen
+Shantanu Jain
Bertrand Janin
Geert Jansen
Jack Jansen
diff --git a/Misc/NEWS.d/next/Documentation/2020-01-24-05-42-57.bpo-39435.EFcdFU.rst b/Misc/NEWS.d/next/Documentation/2020-01-24-05-42-57.bpo-39435.EFcdFU.rst
new file mode 100644
index 0000000..40294c1
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2020-01-24-05-42-57.bpo-39435.EFcdFU.rst
@@ -0,0 +1 @@
+Fix an incorrect signature for :func:`pickle.loads` in the docs \ No newline at end of file