Merge branch 'api-doc-improvements'
[pyi2ncommon] / src / argparse_helpers.py
index 93e4bad..a8d0d04 100644 (file)
 """
 argparse_helpers: Some convenience helpers for argparse
 
-Featuring
-- NonExitingParser: a subclass of ArgumentParser that does not do sys.exit(2)
-  on parse error but instead raises a ArgParserWantsExit exception.
-- function existing_file which can be used as a type in add_argument() calls
+Featuring:
+    - NonExitingParser: a subclass of :py:class:`argparse.ArgumentParser`
+      that does not do *sys.exit(2)* on parse error but instead raises a
+      :py:class:`ArgParserWantsExit` exception.
+    - function existing_file/dir[_or_empty] which can be used as a type in calls to
+      :py:func:`argparse.ArgumentParser.add_argument`
 
 .. codeauthor:: Intra2net
 """