summaryrefslogtreecommitdiff
path: root/config.py
diff options
context:
space:
mode:
authorScott Gasch <[email protected]>2022-05-31 15:36:40 -0700
committerScott Gasch <[email protected]>2022-05-31 15:36:40 -0700
commit02302bbd9363facb59c4df2c1f4013087702cfa6 (patch)
tree938e51338678416afc891d2839c2ee8dd341f34d /config.py
parentf3dbc7dc19ba5703f8f5aa9bf8af3c491b3510f6 (diff)
Improve docstrings for sphinx.
Diffstat (limited to 'config.py')
-rw-r--r--config.py15
1 files changed, 14 insertions, 1 deletions
diff --git a/config.py b/config.py
index c5813a8..7bf812e 100644
--- a/config.py
+++ b/config.py
@@ -41,7 +41,20 @@ Usage:
If you set this up and remember to invoke config.parse(), all commandline
arguments will play nicely together. This is done automatically for you
- if you're using the bootstrap module's initialize wrapper.::
+ if you're using the :meth:`bootstrap.initialize` decorator on
+ your program's entry point. See :meth:`python_modules.bootstrap.initialize`
+ for more details.::
+
+ import bootstrap
+
+ @bootstrap.initialize
+ def main():
+ whatever
+
+ if __name__ == '__main__':
+ main()
+
+ Either way, you'll get this behavior from the commandline::
% main.py -h
usage: main.py [-h]