homepage

Python seems to lack documentation for the OptionGroup class and related methods in the optparse modul.
In detail documentation of the following classes and methods in optparse is missing:
- OptionGroup
- OptionParser.add_option_group
- OptionParser.get_option_group
These classes and methods also lack docstrings.
I found this in Python 2.4.4c1 which comes with Ubuntu 6.10 Edgy. It seems, that Python 2.5 on Ubuntu Edgy also suffers from this bug.

The docstrings need to be modified in the Optik package (from which the stdlib optparse module is derived). I've filed you an appropriate patch there:
http://sourceforge.net/tracker/index.php?func=detail&aid=1669315&group_id=38019&atid=421097. I'll see what I can do about adding some documentation. My preference is only to document OptionParser.add_option_group -- I think making the OptionGroup API public is a mistake (like making the STORE_ACTIONS, etc. APIs public was).

Looks like the optparse docs are also auto-generated from optik. Here's the first line of liboptparse.tex:
% THIS FILE IS AUTO-GENERATED! DO NOT EDIT!
So I guess this needs to be handled in the optparse bugs.

Thanks for filing the patch there! I didn't know, that optparse is developt outside of Python...
Anyway I think you're right not to comment the whole api. I did not intend that. I would be content with a little note in the docs quickly explains OptionGroups and how to create them. More shouldn't be told, since they are only useful for formatting help output.
I just needed such a thing for my recent project and was short of overwriting the OptionParser and HelpFormatter classes. For that purpose I looked into the sources, where I found the OptionGroup capabilities. A little note would have shortened the development of the option parsing code quite a bit... ;)

LunarYorn, thanks for the report. bediviere, thanks to for filing a report with optik. Since the issue is tracked there, I'm closing this report.

Re-opening, since Optik is no longer externally maintained.

Should this be left with AMK or should it be reassigned to docs@python?

Adding docs@ to nosy. amk: Please reassign to docs@ if you don’t intend to work on this.

I will work on it, it noone objects.
Cheers,
Sandro

Hello,
attached is a patch to improve the OptionGroup documentation. I've also changed usage->Usage and options->Options in the examples output, since now the code tries to guess the lower case word and rewrites with the capitalized one.
I'm willing to improve the patch in case there's something not good (and I bet there is, since it's my first complex patch for Python documentation) so please be nice :) and point me to parts that can be improved.
Thanks in advance,
Sandro

sorry, I forgot to wrap at column 80, this patch just changes that.

Could someone give a look to this patch? I can work on fixing the missing stuff (if any :)).

Looks good, applied in r87627 (after removing stray tabs).

I think the documentation for get_option_group is not right. I've created a new bug: http://bugs.python.org/issue11699