Improve documentation.

[pyutils.git] / src / pyutils / datetimez / dateparse_utils.py

diff --git a/src/pyutils/datetimez/dateparse_utils.py b/src/pyutils/datetimez/dateparse_utils.py
index 3ae2e1f3f7d38cc481f7bff7ac144096ad962cc1..89112b4e29fb91a235f13c8f6dbdd74952068fe8 100755 (executable)
--- a/src/pyutils/datetimez/dateparse_utils.py
+++ b/src/pyutils/datetimez/dateparse_utils.py
@@ -100,7 +100,16 @@ class RaisingErrorListener(antlr4.DiagnosticErrorListener):
     ),
 )
 class DateParser(dateparse_utilsListener):
-    """A class to parse dates expressed in human language."""
+    """A class to parse dates expressed in human language.  Example usage::
+
+        d = DateParser()
+        d.parse('next wednesday')
+        dt = d.get_datetime()
+
+    Note that the interface is somewhat klunky here because this class is
+    conforming to interfaces auto-generated by ANTLR as it parses the grammar.
+    See also: string_utils.parse_date.
+    """
 
     PARSE_TYPE_SINGLE_DATE_EXPR = 1
     PARSE_TYPE_BASE_AND_OFFSET_EXPR = 2