summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShantanu <hauntsaninja@users.noreply.github.com>2020-05-01 12:46:01 -0700
committerGitHub <noreply@github.com>2020-05-01 12:46:01 -0700
commit289842ae820f99908d3a345f1f3b6d4e5b4b97fc (patch)
tree2a935029fdf4150325c7e2988dcd2241fd1a099d
parent64224a4727321a8dd33e6f769edda401193ebef0 (diff)
downloadcpython-git-289842ae820f99908d3a345f1f3b6d4e5b4b97fc.tar.gz
bpo-39435: Fix docs for pickle.loads (GH-18160)
-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 a7b92bb953..d92e947a76 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 21822dd752..9221f6aae4 100644
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -790,6 +790,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 0000000000..40294c10df
--- /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