Rewrite blackbox function docstring

emdgroup · Dec 20, 2024 · f32207d · f32207d
1 parent b1d8373
commit f32207d
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/examples/Backtesting/custom_analytical.py b/examples/Backtesting/custom_analytical.py
@@ -49,7 +49,7 @@
 
 
 def blackbox(df: pd.DataFrame, /) -> pd.DataFrame:
-    """Calculate the sum of squares."""
+    """A callable whose internal logic is unknown to the algorithm."""
     return (df[[p.name for p in parameters]] ** 2).sum(axis=1).to_frame(target.name)
 
 

diff --git a/ruff.toml b/ruff.toml
@@ -7,7 +7,9 @@ line-length = 88 # Maximum line length
         # Error regarding too long lines
         "E501",
         # Missing module docstrings
-        "D100"
+        "D100",
+        # In the documentation, imperative mood can be a bit too restrictive
+        "D401",
 ]
 "baybe/utils/__init__.py" = ["F401","F403"]
 "baybe/strategies/__init__.py" = ["F401"]