X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=docs%2Fpyutils.rst;h=2f23a374df67cceed11ee353f93225e2ec2e87e4;hb=a2cb839d6932060ea00ad9b9d7c198ab310affe4;hp=97a222129519c8104728f10c9200519bd565357e;hpb=5bbcfd4dfccd411df0afd03f9790f67b4c852b9c;p=pyutils.git diff --git a/docs/pyutils.rst b/docs/pyutils.rst index 97a2221..2f23a37 100644 --- a/docs/pyutils.rst +++ b/docs/pyutils.rst @@ -2186,17 +2186,18 @@ do some work for you automatically. pyutils.config module --------------------- -The config module is an opinionated way to set up input parameters -to your program. It is enabled by using the :py:mod:`pyutils.bootstrap` -decorator or by simply calling :py:meth:`pyutils.config.parse` early in main -(which is what :py:meth:`pyutils.bootstrap.initialize` does for you). +The config module is an opinionated way to set up input parameters to +your program. It is enabled by using the :py:mod:`pyutils.bootstrap` +decorator around your main entry point or by simply calling +:py:meth:`pyutils.config.parse` early in main (which is what +:py:meth:`pyutils.bootstrap.initialize` does for you). -If you use this module, input parameters to your program can come from +If you use this module, input parameters to your program come from the commandline (and are configured using Python's :py:mod:`argparse`). But they can also be be augmented or replaced using saved configuration files stored either on the local filesystem or on Apache Zookeeper. There is a provision for enabling dynamic arguments (i.e. that can change -during runtime) via Zookeeper. +during runtime) via Zookeeper (which is disabled by default). --- @@ -2208,10 +2209,6 @@ during runtime) via Zookeeper. pyutils.decorator\_utils module ------------------------------- -This is a grab bag of decorators. - ---- - .. automodule:: pyutils.decorator_utils :members: :undoc-members: