Improve docs.

[pyutils.git] / docs / pyutils.datetimez.rst

diff --git a/docs/pyutils.datetimez.rst b/docs/pyutils.datetimez.rst
index 167a22cadca925f62dd27f06b592b05dfcd1f0a0..3b6cf28ca751be45b58d3bfdf005ed803b88b20d 100644 (file)
--- a/docs/pyutils.datetimez.rst
+++ b/docs/pyutils.datetimez.rst
@@ -7,6 +7,8 @@ Submodules
 pyutils.datetimez.constants module
 ----------------------------------
 
+A set of date and time related constants.
+
 .. automodule:: pyutils.datetimez.constants
    :members:
    :undoc-members:
@@ -15,6 +17,16 @@ pyutils.datetimez.constants module
 pyutils.datetimez.dateparse\_utils module
 -----------------------------------------
 
+The dateparse\_utils.DateParser class uses an English language grammar
+(see dateparse\_utils.g4) to parse free form English text into a Python
+datetime.  It can handle somewhat complex constructs such as: "20 days
+from next Wed at 3pm", "last Christmas", and "The 2nd Sunday in May,
+2022".  See the dateparse_utils_test.py for more examples.
+
+This code is used by other code in the pyutils library; for example,
+when using argparse_utils.py to pass an argument of type datetime it
+allows the user to use free form english expressions.
+
 .. automodule:: pyutils.datetimez.dateparse_utils
    :members:
    :undoc-members:
@@ -23,6 +35,9 @@ pyutils.datetimez.dateparse\_utils module
 pyutils.datetimez.dateparse\_utilsLexer module
 ----------------------------------------------
 
+This code is auto-generated by ANTLR from the dateparse\_utils.g4
+grammar.
+
 .. automodule:: pyutils.datetimez.dateparse_utilsLexer
    :members:
    :undoc-members:
@@ -31,6 +46,9 @@ pyutils.datetimez.dateparse\_utilsLexer module
 pyutils.datetimez.dateparse\_utilsListener module
 -------------------------------------------------
 
+This code is auto-generated by ANTLR from the dateparse\_utils.g4
+grammar.
+
 .. automodule:: pyutils.datetimez.dateparse_utilsListener
    :members:
    :undoc-members:
@@ -39,6 +57,9 @@ pyutils.datetimez.dateparse\_utilsListener module
 pyutils.datetimez.dateparse\_utilsParser module
 -----------------------------------------------
 
+This code is auto-generated by ANTLR from the dateparse\_utils.g4
+grammar.
+
 .. automodule:: pyutils.datetimez.dateparse_utilsParser
    :members:
    :undoc-members:
@@ -47,6 +68,11 @@ pyutils.datetimez.dateparse\_utilsParser module
 pyutils.datetimez.datetime\_utils module
 ----------------------------------------
 
+This is a set of utilities for dealing with Python datetimes and
+dates.  It supports operations such as checking timezones,
+manipulating timezones, easy formatting, and using offsets with
+datetimes.
+
 .. automodule:: pyutils.datetimez.datetime_utils
    :members:
    :undoc-members:
@@ -55,6 +81,8 @@ pyutils.datetimez.datetime\_utils module
 Module contents
 ---------------
 
+This module contains utilities for dealing with Python datetimes.
+
 .. automodule:: pyutils.datetimez
    :members:
    :undoc-members: