Issue 993601: optparse needs reference documentation (original) (raw)

Issue993601

➜

This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification

Title:	optparse needs reference documentation
Type:	Stage:
Components:	Documentation	Versions:	Python 2.4

process

Status:	closed	Resolution:	fixed
Dependencies:		Superseder:
Assigned To:	gward	Nosy List:	gward, richard
Priority:	normal	Keywords:

Created on 2004-07-19 06:30 by richard, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (3)
msg21683 - (view)	Author: Richard Jones (richard) *	Date: 2004-07-19 06:30
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.
msg21684 - (view)	Author: Greg Ward (gward)	Date: 2005-03-19 16:30
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.
msg21685 - (view)	Author: Greg Ward (gward)	Date: 2005-03-19 17:05
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.