Skip to content

Commit 782792b

Browse files
Fix documentation to correctly reflect when a track will be deleted
1 parent 2805e3b commit 782792b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

stonesoup/deleter/time.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ def check_for_deletion(self, track, **kwargs):
2727
Returns
2828
-------
2929
bool
30-
`True` if track has an :class:`~.Update` with measurements within
31-
time steps; `False` otherwise.
30+
`False` if track has an :class:`~.Update` with measurements within
31+
time steps; `True` otherwise.
3232
"""
3333
return not any(isinstance(state, Update) and state.hypothesis
3434
for state in track[-self.time_steps_since_update:])
@@ -57,8 +57,8 @@ def check_for_deletion(self, track, timestamp=None, **kwargs):
5757
Returns
5858
-------
5959
bool
60-
`True` if track has an :class:`~.Update` with measurements within
61-
time; `False` otherwise.
60+
`False` if track has an :class:`~.Update` with measurements within
61+
time; `True` otherwise.
6262
"""
6363
if timestamp is None:
6464
timestamp = track.timestamp

0 commit comments

Comments
 (0)