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

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 a7b92bb9538d90a243de07e3a8e5ea70a7fe128d..d92e947a76403e1cf7017e8d4d70d7279d80a487 100644 (file)
@@ -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
index 9d8c0f9a48626ec9eb395c3df0a0340a117caab0..34a6fc439e89c15bc4ed3e88b17838b3e09c9447 100644 (file)
--- 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 (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