Clarify that __getinitargs__ is called at pickle time!

diff --git a/Doc/lib/libpickle.tex b/Doc/lib/libpickle.tex
index 508e50ddcc2c95e4377260b704da63504d5d7019..0d31059946705798289f94661c6b97362e9a1511 100644 (file)
--- a/Doc/lib/libpickle.tex
+++ b/Doc/lib/libpickle.tex
@@ -103,7 +103,9 @@ desirable to have a constructor that requires arguments; it is a
 If it is desirable that the \code{__init__} method be called on
 unpickling, a class can define a method \code{__getinitargs__()},
 which should return a {\em tuple} containing the arguments to be
-passed to the class constructor (\code{__init__()}).
+passed to the class constructor (\code{__init__()}).  This method is
+called at pickle time; the tuple it returns is incorporated in the
+pickle for the instance.
 \ttindex{__getinitargs__}
 \ttindex{__init__}
 

diff --git a/Doc/libpickle.tex b/Doc/libpickle.tex
index 508e50ddcc2c95e4377260b704da63504d5d7019..0d31059946705798289f94661c6b97362e9a1511 100644 (file)
--- a/Doc/libpickle.tex
+++ b/Doc/libpickle.tex
@@ -103,7 +103,9 @@ desirable to have a constructor that requires arguments; it is a
 If it is desirable that the \code{__init__} method be called on
 unpickling, a class can define a method \code{__getinitargs__()},
 which should return a {\em tuple} containing the arguments to be
-passed to the class constructor (\code{__init__()}).
+passed to the class constructor (\code{__init__()}).  This method is
+called at pickle time; the tuple it returns is incorporated in the
+pickle for the instance.
 \ttindex{__getinitargs__}
 \ttindex{__init__}