]> granicus.if.org Git - python/commitdiff
[2.7] bpo-22392: Improve documentation for __getinitargs__ (GH-899)
authorMandeep Singh <daxlab@users.noreply.github.com>
Thu, 30 Mar 2017 20:39:06 +0000 (02:09 +0530)
committerMariatta <Mariatta@users.noreply.github.com>
Thu, 30 Mar 2017 20:39:06 +0000 (13:39 -0700)
Doc/library/pickle.rst

index 41be2c4eb60be6379f45efbfe7e0d15d9b13f39f..67f27de1ce55c36ba563b7a83ef9a2c1fe336b8b 100644 (file)
@@ -418,10 +418,11 @@ Pickling and unpickling normal class instances
    When a pickled class instance is unpickled, its :meth:`__init__` method is
    normally *not* invoked.  If it is desirable that the :meth:`__init__` method
    be called on unpickling, an old-style class can define a method
-   :meth:`__getinitargs__`, which should return a *tuple* containing the
+   :meth:`__getinitargs__`, which should return a *tuple* of positional
    arguments to be passed to the class constructor (:meth:`__init__` for
-   example).  The :meth:`__getinitargs__` method is called at pickle time; the
-   tuple it returns is incorporated in the pickle for the instance.
+   example).  Keyword arguments are not supported.  The :meth:`__getinitargs__`
+   method is called at pickle time; the tuple it returns is incorporated in the
+   pickle for the instance.
 
 .. method:: object.__getnewargs__()