More documentation improvements.
[pyutils.git] / src / pyutils / argparse_utils.py
index f142d7e4a4adeb42c7e6f2d82031fc99ed732232..a0b4cc24d587690d9a59564e8000a656c2c7c645 100644 (file)
@@ -3,10 +3,15 @@
 # © Copyright 2021-2022, Scott Gasch
 
 """These are helpers for commandline argument parsing meant to work
 # © Copyright 2021-2022, Scott Gasch
 
 """These are helpers for commandline argument parsing meant to work
-with Python's :mod:`argparse` module from the standard library.  It
-contains validators for new argument types (such as free-form dates,
-durations, IP addresses, etc...)  and an action that creates a pair of
-flags: one to disable a feature and another to enable it.
+with Python's :mod:`argparse` module from the standard library (See:
+https://docs.python.org/3/library/argparse.html).  It contains
+validators for new argument types (such as free-form dates, durations,
+IP addresses, etc...)  and an action that creates a pair of flags: one
+to disable a feature and another to enable it.
+
+See also :py:class:`pyutils.config.OptionalRawFormatter` which is
+automatically enabled if you use :py:mod:`config` module.
+
 """
 
 import argparse
 """
 
 import argparse
@@ -367,7 +372,7 @@ def valid_datetime(txt: str) -> datetime.datetime:
     .. note::
         Because this code uses an English date-expression parsing grammar
         internally, much more complex datetimes can be expressed in free form.
     .. note::
         Because this code uses an English date-expression parsing grammar
         internally, much more complex datetimes can be expressed in free form.
-        See: `tests/datetimez/dateparse_utils_test.py` for examples.  These
+        See :mod:`pyutils.datetimez.dateparse_utils` for details.  These
         are not included in here because they are hard to write valid doctests
         for!
 
         are not included in here because they are hard to write valid doctests
         for!