]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.7] bpo-39435: Fix docs for pickle.loads (GH-18160). (GH-19844)
authorAntoine Pitrou <antoine@python.org>
Fri, 1 May 2020 19:53:35 +0000 (21:53 +0200)
committerGitHub <noreply@github.com>
Fri, 1 May 2020 19:53:35 +0000 (12:53 -0700)
(cherry picked from commit 289842ae820f99908d3a345f1f3b6d4e5b4b97fc)

Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
Automerge-Triggered-By: @pitrou
Doc/library/pickle.rst
Misc/ACKS
Misc/NEWS.d/next/Documentation/2020-01-24-05-42-57.bpo-39435.EFcdFU.rst [new file with mode: 0644]

index d638944756e7a026632f61e5ab01381b4c855200..25044899f242a2667f409cd4f41a03b83567b9c9 100644 (file)
@@ -242,10 +242,10 @@ process more convenient:
    instances of :class:`~datetime.datetime`, :class:`~datetime.date` and
    :class:`~datetime.time` pickled by Python 2.
 
-.. function:: loads(bytes_object, \*, fix_imports=True, encoding="ASCII", errors="strict")
+.. function:: loads(data, \*, fix_imports=True, encoding="ASCII", errors="strict")
 
    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
index 27ef39754afd9033a997c734c6aec6ad1f525a28..ce269edbd51bf1d91aa29b1c3861e73719577a25 100644 (file)
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -746,6 +746,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 (file)
index 0000000..40294c1
--- /dev/null
@@ -0,0 +1 @@
+Fix an incorrect signature for :func:`pickle.loads` in the docs
\ No newline at end of file