Skip to content

Commit 14fe52e

Browse files
Add checks.md to documentation utils
1 parent ed5526c commit 14fe52e

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

docs/source/api_reference/utils.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ The {mod}`frouros.utils` module contains auxiliary classes, functions or excepti
55
```{toctree}
66
:maxdepth: 2
77
8+
utils/checks
89
utils/data_structures
910
utils/kernels
1011
utils/stats
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Checks
2+
3+
The {mod}`frouros.utils.checks` module contains auxiliary checks functions.
4+
5+
```{eval-rst}
6+
.. automodule:: frouros.utils.checks
7+
:members:
8+
:no-inherited-members:
9+
```

frouros/utils/checks.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
from frouros.callbacks.base import BaseCallback
66

77

8-
def check_callbacks(callbacks: Any, expected_cls: BaseCallback) -> None:
8+
def check_callbacks(
9+
callbacks: Any,
10+
expected_cls: BaseCallback,
11+
) -> None:
912
"""Check callbacks.
1013
1114
:param callbacks: callbacks

0 commit comments

Comments
 (0)