From d44e7ad7029752720f1bdef7de7779394be98956 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Thu, 15 Nov 2001 23:37:26 +0000 Subject: Minor updates to add more pointers to the pickle documentation, and to clarify some of the interface. --- Doc/lib/libcopyreg.tex | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Doc/lib/libcopyreg.tex b/Doc/lib/libcopyreg.tex index bdeca88..25cc505 100644 --- a/Doc/lib/libcopyreg.tex +++ b/Doc/lib/libcopyreg.tex @@ -24,9 +24,15 @@ functions or class instances. Declares that \var{function} should be used as a ``reduction'' function for objects of type \var{type}; \var{type} should not a class object. \var{function} should return either a string or a - tuple. The optional \var{constructor} parameter, if provided, is a + tuple containing two or three elements. + + The optional \var{constructor} parameter, if provided, is a callable object which can be used to reconstruct the object when called with the tuple of arguments returned by \var{function} at pickling time. \exception{TypeError} will be raised if \var{object} is a class or \var{constructor} is not callable. + + See the \refmodule{pickle} module for more + details on the interface expected of \var{function} and + \var{constructor}. \end{funcdesc} -- cgit v0.12