optparse needs reference documentation

[richard]

BPO	993601

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2005-03-19.17:05:56.000>
created_at = <Date 2004-07-19.06:30:31.000>
labels = ['docs']
title = 'optparse needs reference documentation'
updated_at = <Date 2005-03-19.17:05:56.000>
user = 'https://bugs.python.org/richard'

bugs.python.org fields:

activity = <Date 2005-03-19.17:05:56.000>
actor = 'gward'
assignee = 'gward'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2004-07-19.06:30:31.000>
creator = 'richard'
dependencies = []
files = []
hgrepos = []
issue_num = 993601
keywords = []
message_count = 3.0
messages = ['21683', '21684', '21685']
nosy_count = 2.0
nosy_names = ['gward', 'richard']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue993601'
versions = ['Python 2.4']

[richard]

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.

[gward]

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.

[gward]

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.