From: Antoine Pitrou Date: Fri, 1 May 2020 19:53:35 +0000 (+0200) Subject: [3.7] bpo-39435: Fix docs for pickle.loads (GH-18160). (GH-19844) X-Git-Tag: v3.7.8rc1~71 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=3859b1ac1d7014f8ff673962d94a01a408546e24;p=thirdparty%2FPython%2Fcpython.git [3.7] bpo-39435: Fix docs for pickle.loads (GH-18160). (GH-19844) (cherry picked from commit 289842ae820f99908d3a345f1f3b6d4e5b4b97fc) Co-authored-by: Shantanu Automerge-Triggered-By: @pitrou --- diff --git a/Doc/library/pickle.rst b/Doc/library/pickle.rst index d638944756e7..25044899f242 100644 --- a/Doc/library/pickle.rst +++ b/Doc/library/pickle.rst @@ -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 diff --git a/Misc/ACKS b/Misc/ACKS index 27ef39754afd..ce269edbd51b 100644 --- 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 index 000000000000..40294c10df00 --- /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