fill in docstring for benchmark test (currently skipped)

brainglobe · Dec 11, 2023 · c3974c0 · c3974c0
1 parent 6e5a9a8
commit c3974c0
Showing 1 changed file with 7 additions and 6 deletions.
diff --git a/tests/test_integration/brainglobe_benchmarks/test_cellfinder.py b/tests/test_integration/brainglobe_benchmarks/test_cellfinder.py
@@ -7,20 +7,21 @@
 
 
 @pytest.fixture()
-def asv_config_monkeypatched_path(tmp_path):
-    """Create a monkeypatched asv.conf.json file
-    in tmp_path and return its path
+def asv_config_monkeypatched_path(tmp_path: Path) -> str:
+    """
+    Create a monkeypatched asv.conf.json file
+    in a Pytest-generated temporary directory
+    and return its path
 
     Parameters
     ----------
     tmp_path : Path
         path to pytest-generated temporary directory
 
-
     Returns
     -------
-    _type_
-        _description_
+    str
+        Path to monkeypatched asv config file
     """
     # read reference asv config
     asv_original_path = Path(__file__).resolve().parents[3] / "asv.conf.json"