From 0d213a37ca774e403c3456b37ff5662fd45b7402 Mon Sep 17 00:00:00 2001 From: johnowagon <97626704+johnowagon@users.noreply.github.com> Date: Mon, 11 Dec 2023 08:11:09 -0700 Subject: [PATCH] Issue #78: Added ruff configuration to check docstring style --- .ruff.toml | 37 ++++++++++++++++++- .../scenario/environment_features.py | 2 +- 2 files changed, 37 insertions(+), 2 deletions(-) diff --git a/.ruff.toml b/.ruff.toml index 39bec903..0e7439f9 100644 --- a/.ruff.toml +++ b/.ruff.toml @@ -1 +1,36 @@ -ignore-init-module-imports = true \ No newline at end of file +ignore-init-module-imports = true +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 +] \ No newline at end of file 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 index 7f7d60a2..88b652c9 100644 --- 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. """