[ python-Bugs-993601 ] optparse needs reference documentation

[SourceForge.net]

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

Category: Documentation
Group: Python 2.4
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: Richard Jones (richard)
Assigned to: Greg Ward (gward)
Summary: optparse needs reference documentation

Initial Comment:
The optparse libref documentation, while extensive, 
doesn't actually include an API reference. There's no way 
of knowing the valid parameter set of 
OptionParser.add_option() without going through the 
source. 
 
Please consider adding an API reference page for each of 
OptionParser (including OptionContainer), Values, Option 
(aka make_option) and OptionGroup. 
 

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

>Comment By: Greg Ward (gward)
Date: 2005-03-19 12:05

Message:
Logged In: YES 
user_id=14422

Finished in Optik svn r502 and r503 -- now lists all option
attributes in a separate section.

Ported to Python CVS on 2.4 branch: Doc/lib/liboptparse.tex
rev 1.18.2.3.

Will port to Python CVS trunk later.

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

Comment By: Greg Ward (gward)
Date: 2005-03-19 11:30

Message:
Logged In: YES 
user_id=14422

Partially addressed in Optik svn r501 (everything important
but the list of keyword args to parser.add_option() is
documented now).  More updates coming soon, I hope.

Ported to Python CVS on 2.4 branch: Doc/lib/liboptparse.tex
rev 1.18.2.2 .

Will port to Python CVS trunk later -- post release of Optik
1.5.1.


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

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