[Python-bugs-list] [ python-Bugs-530143 ] Typo in 3.16 copy_reg doc

[noreply@sourceforge.net]

Bugs item #530143, was opened at 2002-03-14 18:49
You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=530143&group_id=5470

Category: Documentation
Group: None
Status: Closed
Resolution: Fixed
Priority: 5
Submitted By: Martin Miller (mrmiller)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: Typo in 3.16 copy_reg doc

Initial Comment:
On the page at <http://www.python.org/doc/current/lib/module-copyreg.html> in the second 
half about the pickle function, it says, in part:

> pickle(type, function[, constructor]) 
>     Declares that function should be used as a ``reduction'' function for objects of type type;
>     type should not a class object. function should return either a string or a tuple containing 
>     two or three elements. 

The part that says "type should not a class object" seems wrong. I think it should probably be 
"type should be a class object".


----------------------------------------------------------------------

>Comment By: Martin Miller (mrmiller)
Date: 2002-03-19 08:34

Message:
Logged In: YES 
user_id=257085

"type should not a class object" is not a complete sentence in English and is incorrect (if it means what I 
can only guess it means). In other words, I think the type argument to the pickle() function here "should be 
a class object". My comments are not about the need for the function or its functionality, so the response 
that "Actually, the docs are right." seems inappropriate...



----------------------------------------------------------------------

Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2002-03-18 19:33

Message:
Logged In: YES 
user_id=3066

Actually, the docs are right, aside from not being very
clear.  This functionality is there to support extension
types introduced before the __reduce__() method was defined
in the pickle protocol.

I've clarified this in Doc/lib/libcopyreg.tex revisions
1.10.8.1 and 1.11.

----------------------------------------------------------------------

You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=530143&group_id=5470