Skip to content

Commit d124f1b

Browse files
author
Moritz-Alexander-Kern
committed
add module docstring for filters.py
1 parent afdc1f5 commit d124f1b

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

neo/core/filters.py

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11
"""
2-
This module implements :class:`FilterCondition`, which enables use of different filter conditions for
3-
neo.core.container.filter.
2+
This module implements :class:`FilterCondition`, which enables use of different filter conditions
3+
for neo.core.container.filter.
4+
5+
Classes:
6+
- :class:`FilterCondition`: Abstract base class for defining filter conditions.
7+
- :class:`Equals`: Filter condition to check if a value is equal to the control value.
8+
- :class:`IsNot`: Filter condition to check if a value is not equal to the control value.
9+
- :class:`LessThanEquals`: Filter condition to check if a value is less than or equal to the
10+
control value.
11+
- :class:`GreaterThanEquals`: Filter condition to check if a value is greater than or equal to
12+
the control value.
13+
- :class:`LessThan`: Filter condition to check if a value is less than the control value.
14+
- :class:`GreaterThan`: Filter condition to check if a value is greater than the control value.
15+
- :class:`IsIn`: Filter condition to check if a value is in a list or equal to the control
16+
value.
17+
- :class:`InRange`: Filter condition to check if a value is in a specified range.
18+
19+
The provided classes allow users to select filter conditions and use them with
20+
:func:`neo.core.container.filter()` to perform specific filtering operations on data.
421
"""
522
from abc import ABC, abstractmethod
623

0 commit comments

Comments
 (0)