Update pyproject.toml

aristanetworks · Sep 11, 2024 · 72d8c8f · 72d8c8f
1 parent 740fe67
commit 72d8c8f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -328,6 +328,9 @@ target-version = "py39"
 [tool.ruff.lint]
 # select all cause we like being suffering
 select = ["ALL",
+    # By enabling a convention for docstrings, ruff automatically ignore some rules that need to be
+    # added back if we want them.
+    # https://docs.astral.sh/ruff/faq/#does-ruff-support-numpy-or-google-style-docstrings
     # TODO: Augment the numpy convention rules to make sure we add all the params
     #       Uncomment below D417
     "D415",