]> arthur.barton.de Git - bup.git/commit
options.py: update docstrings and detail optspec
authorGabriel Filion <lelutin@gmail.com>
Sat, 5 Feb 2011 22:17:47 +0000 (17:17 -0500)
committerAvery Pennarun <apenwarr@gmail.com>
Sun, 6 Feb 2011 01:57:45 +0000 (17:57 -0800)
commit67087b3d158fdfa3012e05818c1fbb9604dffcba
tree041024299e8aa85993d0373d2d40924bf5627266
parent6c2c0f678d458a90eaf606707b59154f62cef62b
options.py: update docstrings and detail optspec

The docstring on the Options class currently refers to a man page which
does not exist, and still talks about the now-removed 'exe' parameter.
Update this to be more accurate.

Add a docstring to OptDict.

Finally, the options.py file brings a concept of option spec string. Its
construction should be documented. Since we'd like the options.py file
to be a one-file drop-in so that it can be easily used in other
projects, let's document the option specs in the module's docstring.

Signed-off-by: Gabriel Filion <lelutin@gmail.com>
lib/bup/options.py