ci: ensure docstrings are formatted (#156)

* ci: ensure docstrings are formatted Signed-off-by: nstarman <[email protected]> * fix: docs Signed-off-by: nstarman <[email protected]> --------- Signed-off-by: nstarman <[email protected]>
beartype · Jun 11, 2024 · 6dcb9f1 · 6dcb9f1
1 parent e2f8961
commit 6dcb9f1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/plum/parametric.py b/plum/parametric.py
@@ -196,7 +196,9 @@ def __init_type_parameter__(cls, *ps) -> tuple:
 
         @classmethod
         def __le_type_parameter__(cls, left, right) -> bool:
-            ...  # Is `left <= right`?
+            # Is `left <= right`?
+            ...
+
     """
 
     original_meta = type(original_class)
@@ -307,8 +309,10 @@ def __class_nonparametric__(cls):
         ...     @classmethod
         ...     def __infer_type_parameter__(cls, *arg):
         ...         return type(arg[0])
+        ...
         ...     def __init__(self, x):
         ...         self.x = x
+        ...
         ...     def __repr__(self):
         ...         return f"Obj({self.x})"
         >>> PObj = parametric(Obj)
@@ -357,8 +361,10 @@ def __class_unparametrized__(cls):
         ...     @classmethod
         ...     def __infer_type_parameter__(cls, *arg):
         ...         return type(arg[0])
+        ...
         ...     def __init__(self, x):
         ...         self.x = x
+        ...
         ...     def __repr__(self):
         ...         return f"Obj({self.x})"
         >>> PObj = parametric(Obj)
@@ -491,8 +497,10 @@ def type_nonparametric(q: T) -> Type[T]:
     ...     @classmethod
     ...     def __infer_type_parameter__(cls, *arg):
     ...         return type(arg[0])
+    ...
     ...     def __init__(self, x):
     ...         self.x = x
+    ...
     ...     def __repr__(self):
     ...         return f"Obj({self.x})"
     >>> PObj = parametric(Obj)
@@ -557,8 +565,10 @@ def type_unparametrized(q: T) -> Type[T]:
     ...     @classmethod
     ...     def __infer_type_parameter__(cls, *arg):
     ...         return type(arg[0])
+    ...
     ...     def __init__(self, x):
     ...         self.x = x
+    ...
     ...     def __repr__(self):
     ...         return f"Obj({self.x})"
     >>> PObj = parametric(Obj)

diff --git a/pyproject.toml b/pyproject.toml
@@ -81,15 +81,17 @@ line-length = 88
 select = [
     "B",  # flake8-bugbear
     "D410",
-    "E",  # pycodestyle
+    "E", "W",  # pycodestyle
     "F",  # Pyflakes
     "I",  # isort
     "SIM",  # flake8-simplify
     "UP",  # pyupgrade
-    "W",
 ]
 ignore = ["F811", "B018"]
 
 [tool.ruff.lint.isort]
 known-first-party = ["beartype"]
 known-local-folder = ["plum"]
+
+[tool.ruff.format]
+docstring-code-format = true