File tree 1 file changed +17
-1
lines changed 1 file changed +17
-1
lines changed Original file line number Diff line number Diff line change @@ -1359,7 +1359,8 @@ class DateField(StringField):
1359
1359
value when none has been specified.
1360
1360
1361
1361
index (bool): Determine if this field should be indexed by default in a
1362
- ``FactBase```. Defaults to ``False``.
1362
+ ``FactBase```. Defaults to ``False``. WARNING: this parameter will be deprecated in
1363
+ a future version of Clorm. Indexing should be explicitly set in the FactBase object.
1363
1364
1364
1365
"""
1365
1366
@@ -1370,6 +1371,21 @@ def __init__(
1370
1371
default_factory : Callable [[], Any ] = MISSING ,
1371
1372
index : Any = MISSING ,
1372
1373
) -> None :
1374
+ """Initialize a field instance.
1375
+
1376
+ Args:
1377
+
1378
+ default: A default value to be used when instantiating a ``Predicate`` object and no
1379
+ value has been specified.
1380
+
1381
+ default_factory: A unary function (ie. a function with no arguments) for generating a
1382
+ value when none has been specified.
1383
+
1384
+ index (bool): Determine if this field should be indexed by default in a
1385
+ ``FactBase```. Defaults to ``False``. WARNING: this parameter will be deprecated in
1386
+ a future version of Clorm. Indexing should be explicitly set in the FactBase object.
1387
+
1388
+ """
1373
1389
self ._index = index if index is not MISSING else False
1374
1390
if default is not MISSING and default_factory is not MISSING :
1375
1391
raise ValueError ("can not specify both default and default_factory" )
You can’t perform that action at this time.
0 commit comments