Commits

Anonymous committed fd2df7b Draft

Tweaked documentation for a better elevator pitch.

Comments (0)

Files changed (3)

 -------------------------
 
 Yes well I don't blame you. First things first: it's a Python utility for
-writing commandline scripts. What does it do? The elevator pitch is, "With
-``argparse_config`` your commandline applications will understand config files
-automatically, based on the commandline arguments you specify." More details
-("But what does this mean for *me*?!) on PyPI_, or you can check the
-`bleeding edge docs`_.
+your commandline scripts. What does it do? The elevator pitch is:
+
+    The ``argparse_config`` utility reads defaults for commandline args from a
+    config file. The cute thing is, it figures out what config options to
+    expect based on your ``argparse`` commandline args definition.
+
+More details ("But what does this mean for *me*?!) on PyPI_, or you can check
+the `bleeding edge docs`_.
 
 .. _PyPI: http://pypi.python.org/pypi/argparse_config/
 .. _bleeding edge docs: http://bitbucket.org/tikitu/argparse_config/src/tip/argparse_config.src/README.rst?at=default

argparse_config.src/README.rst

-With ``argparse_config`` your commandline applications will understand config
-files automatically, based on the commandline arguments you specify.
+The ``argparse_config`` utility reads defaults for commandline args from a
+config file. The cute thing is, it figures out what config options to expect
+based on your ``argparse`` commandline args definition.
 
 Let's say I'm reimplementing the Mercurial commandline client. I specify the
 commandline argument processing with ``argparse``, of course::

argparse_config.src/argparse_config/tests/__init__.py

             read_config(arg_parser, temp_file.name)
         parsed_args = arg_parser.parse_args([])
         self.assertTrue(parsed_args.verbose)
-