Issue #78: Added ruff configuration to check docstring style

AVSLab · Dec 11, 2023 · bad876d · bad876d
1 parent 1692bc2
commit bad876d
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 2 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,4 +32,41 @@
     ]
 
 [project.scripts]
-    finish_install = "bsk_rl.finish_install:pck_install"
+    finish_install = "bsk_rl.finish_install:pck_install"
+
+[tool.ruff]
+exclude = [
+    ".txt",
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    "__pypackages__",
+    "__pycache__",
+    "_build",
+    "buck-out",
+    "build",
+    "docs",
+    "dist",
+    "node_modules",
+    "venv",
+]
+
+select = [
+    "D205", # Blank line after summary
+    "D103", # Public function needs docstring
+    "D101", # Class needs docstring
+    "D102", # Method needs docstring
+    "D417", # Document all arguments
+    "D419", # Docstring is empty
+]
diff --git a/src/bsk_rl/envs/general_satellite_tasking/scenario/environment_features.py b/src/bsk_rl/envs/general_satellite_tasking/scenario/environment_features.py
@@ -158,7 +158,7 @@ class UniformNadirFeature(EnvironmentFeatures):
     """Defines a nadir target center at the center of the planet."""
 
     def __init__(self, value_per_second: float = 1.0) -> None:
-        """"
+        """
         Args:
             value_per_second: Amount of reward per second imaging nadir.
         """
-Original file line number
+Diff line change
@@ Expand Up / @@ -158,7 +158,7 @@ class UniformNadirFeature(EnvironmentFeatures): @@
         """Defines a nadir target center at the center of the planet."""
         def __init__(self, value_per_second: float = 1.0) -> None:
-            """"
+            """
             Args:
                 value_per_second: Amount of reward per second imaging nadir.
             """
@@ Expand Down @@