Commit d44e7ad7 authored by Barry Warsaw's avatar Barry Warsaw

Minor updates to add more pointers to the pickle documentation, and to

clarify some of the interface.
parent fd4f069b
...@@ -24,9 +24,15 @@ functions or class instances. ...@@ -24,9 +24,15 @@ functions or class instances.
Declares that \var{function} should be used as a ``reduction'' Declares that \var{function} should be used as a ``reduction''
function for objects of type \var{type}; \var{type} should not a function for objects of type \var{type}; \var{type} should not a
class object. \var{function} should return either a string or 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 callable object which can be used to reconstruct the object when
called with the tuple of arguments returned by \var{function} at called with the tuple of arguments returned by \var{function} at
pickling time. \exception{TypeError} will be raised if pickling time. \exception{TypeError} will be raised if
\var{object} is a class or \var{constructor} is not callable. \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} \end{funcdesc}
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment