commit 6cbf20b0442206ff777cdddfb2de123e03e82ff1 Author: Isis Lovecruft isis@torproject.org Date: Tue Apr 22 23:18:02 2014 +0000
Add module docstring for bridgedb.parse.options. --- lib/bridgedb/parse/options.py | 35 +++++++++++++++++++++++++++++++---- 1 file changed, 31 insertions(+), 4 deletions(-)
diff --git a/lib/bridgedb/parse/options.py b/lib/bridgedb/parse/options.py index 0285184..3b1004d 100644 --- a/lib/bridgedb/parse/options.py +++ b/lib/bridgedb/parse/options.py @@ -8,10 +8,37 @@ # (c) 2007-2013, all entities within the AUTHORS file # :license: 3-clause BSD, see included LICENSE for information
-"""Classes for commandline options parsing. - -** Module Overview: ** - +"""Parsers for BridgeDB commandline options. + +.. py:module:: bridgedb.parse.options + :synopsis: Parsers for BridgeDB commandline options. + + +bridgedb.parse.options +====================== +:: + + bridgedb.parse.options + |__ setConfig() + |__ getConfig() - Set/Get the config file path. + |__ setRundir() + |__ getRundir() - Set/Get the runtime directory. + |__ parseOptions() - Create the main options parser for BridgeDB. + | + _ BaseOptions - Base options, included in all other options menus. + || + |__ findRundirAndConfigFile() - Find the absolute path of the config + | file and runtime directory, or find + | suitable defaults. + | + |__ SIGHUPOptions - Menu to explain SIGHUP signal handling and usage. + |__ SIGUSR1Options - Menu to explain SIGUSR1 handling and usage. + | + |__ MockOptions - Suboptions for creating fake bridge descriptors for + | testing purposes. + |__ TestOptions - Suboptions for running twisted.trial based unittests. + __ MainOptions - Main commandline options parser for BridgeDB. +.. """
from __future__ import print_function