fixed docstring checker to ignore dataclass methods

catalystneuro · Sep 5, 2023 · 1167d13 · 1167d13
1 parent b87b071
commit 1167d13
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/roiextractors/extraction_tools.py b/src/roiextractors/extraction_tools.py
@@ -1,3 +1,10 @@
+"""Various tools for extraction of ROIs from imaging data.
+
+Classes
+-------
+VideoStructure
+    A data class for specifying the structure of a video.
+"""
 import sys
 import importlib.util
 from functools import wraps
@@ -108,7 +115,6 @@ class VideoStructure:
         channels_axis=channels_axis,
         frame_axis=frame_axis,
     )
-
     """
 
     num_rows: int

diff --git a/tests/test_docstrings.py b/tests/test_docstrings.py
@@ -50,6 +50,8 @@ def test_has_docstring(obj):
         msg = f"{obj.__name__} has no docstring."
     else:
         msg = f"{obj.__module__}.{obj.__qualname__} has no docstring."
+        if "__create_fn__" in msg:
+            return  # skip dataclass functions created by __create_fn__
     assert doc is not None, msg