Document "Date", "Datetime" and "Time" trait types (#1641)

* DOC: Document Date, Datetime and Time traits fixes #1445 modified: docs/source/traits_user_manual/defining.rst * CLN: Address review comments modified: docs/source/traits_user_manual/defining.rst
enthought · May 10, 2022 · 9af04c7 · 9af04c7
1 parent d056140
commit 9af04c7
Showing 1 changed file with 13 additions and 3 deletions.
diff --git a/docs/source/traits_user_manual/defining.rst b/docs/source/traits_user_manual/defining.rst
@@ -261,13 +261,13 @@ trait cannot be used as a simple name, it is omitted from the Name column of
 the table.
 
 .. index:: Any(), Array(), Button(), Callable(), CArray(), Code()
-.. index:: CSet(), Constant(), Dict()
+.. index:: CSet(), Constant(), Date(), Datetime(), Dict()
 .. index:: Directory(), Disallow, Either(), Enum()
 .. index:: Event(), Expression(), false, File()
 .. index:: Instance(), List(), Method(), Module()
 .. index:: Password(), Property(), Python()
 .. index:: PythonValue(), Range(), ReadOnly(), Regex()
-.. index:: Set() String(), This,
+.. index:: Set() String(), This, Time()
 .. index:: ToolbarButton(), true, Tuple(), Type()
 .. index:: undefined, UUID(), ValidatedTuple(), WeakRef()
 
@@ -280,7 +280,7 @@ the table.
 +==================+==========================================================+
 | Any              | Any( [*default_value* = None, \*,                        |
 |                  | *factory* = None, *args* = (), *kw* = {},                |
-|                  | \*\*\ *metadata* )                                       |
+|                  | \*\*\ *metadata*] )                                      |
 +------------------+----------------------------------------------------------+
 | Array            | Array( [*dtype* = None, *shape* = None, *value* = None,  |
 |                  | \*\*\ *metadata*] )                                      |
@@ -306,6 +306,13 @@ the table.
 +------------------+----------------------------------------------------------+
 | Constant         | Constant( *value*\ [, \*\*\ *metadata*] )                |
 +------------------+----------------------------------------------------------+
+| Date             | Date( *value*\ [, *default_value* = None,                |
+|                  | *allow_datetime* = None, *allow_none* = None,            |
+|                  | \*\*\ *metadata*] )                                      |
++------------------+----------------------------------------------------------+
+| Datetime         | Datetime( *value*\ [, *default_value* = None,            |
+|                  | *allow_none* = None, \*\*\ *metadata*])                  |
++------------------+----------------------------------------------------------+
 | Dict             | Dict( [*key_trait* = None, *value_trait* = None,         |
 |                  | *value* = None, *items* = True, \*\*\ *metadata*] )      |
 +------------------+----------------------------------------------------------+
@@ -386,6 +393,9 @@ the table.
 +------------------+----------------------------------------------------------+
 | This             | n/a                                                      |
 +------------------+----------------------------------------------------------+
+| Time             | Time( *value*\ [, *default_value* = None,                |
+|                  | *allow_none* = None, \*\*\ *metadata*])                  |
++------------------+----------------------------------------------------------+
 | ToolbarButton    | ToolbarButton( [*label* = '', *image* = None, *style* =  |
 |                  | 'toolbar', *orientation* = 'vertical', *width_padding* = |
 |                  | 2, *height_padding* = 2, \*\*\ *metadata*] )             |