[ python-Bugs-891249 ] pickle dump argument description vague

[SourceForge.net]

Bugs item #891249, was opened at 2004-02-05 19:08
Message generated for change (Settings changed) made by bkc
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=891249&group_id=5470

Category: Documentation
Group: Python 2.3
Status: Open
Resolution: None
Priority: 5
Submitted By: Brad Clements (bkc)
>Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: pickle dump argument description vague

Initial Comment:
The documentation for pickle.dump()

see http://www.python.org/doc/current/lib/node64.html

dump(  	object, file[, protocol[, bin]])

implies that up to four arguments can be specified.
That bin can be specified if protocol has been
specified. The implementation actually accepts only 3
arguments, the last one being either 'protocol' or a
'bin' flag.

The text notation for this function needs to be
clarified, and the visual presentation of the argument
functions changed.

Perhaps to:

dump(  	object, file[, protocol | bin])

or

dump(  	object, file[, protocol] | [, bin])

or

dump(  	object, file[, protocol_or_bin])




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

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