Skip to content

Commit fb97db3

Browse files
committed
Documentation update
1 parent 2bce4cf commit fb97db3

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

kadi/commands/core.py

+7-2
Original file line numberDiff line numberDiff line change
@@ -1144,7 +1144,10 @@ def get_cxotime_now() -> str | None:
11441144

11451145
def filter_cmd_events_date_stop(date_stop):
11461146
"""
1147-
Returns a function that removes command events with ``Date > date_stop``.
1147+
Returns an event filter function to remove events with ``Date > date_stop``.
1148+
1149+
The returned function can be used as an ``event_filter`` argument to ``get_cmds()``
1150+
and other related functions.
11481151
11491152
Parameters
11501153
----------
@@ -1154,7 +1157,9 @@ def filter_cmd_events_date_stop(date_stop):
11541157
Returns
11551158
-------
11561159
Callable
1157-
Function that takes a Table of command events and returns a boolean numpy array.
1160+
Function that takes a Table of command events and returns a boolean numpy array
1161+
of the same length as the table. The array is a mask and ``True`` entries are
1162+
kept.
11581163
"""
11591164

11601165
def func(cmd_events):

0 commit comments

Comments
 (0)