Replace pydocstyle with Ruff (#20) (#21)

* Replace pydocstyle with Ruff * Single call * More precise ignore * Revert "More precise ignore" This reverts commit 71aeb87. (cherry picked from commit d70fb57) Co-authored-by: Eric Arellano <[email protected]>
Qiskit · Oct 24, 2024 · 5be2258 · 5be2258
1 parent c20b6d1
commit 5be2258
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/pyproject.toml b/pyproject.toml
@@ -59,7 +59,6 @@ style = [
 ]
 lint = [
     "qiskit-addon-mpf[style]",
-    "pydocstyle==6.3.0",
     "mypy==1.11.2",
     "pylint==3.2.7",
     "reno>=4.1",
@@ -138,6 +137,7 @@ select = [
     "I",   # isort
     "E",   # pycodestyle
     "W",   # pycodestyle
+    "D",   # pydocstyle
     "F",   # pyflakes
     "RUF", # ruff
     "UP",  # pyupgrade
@@ -153,8 +153,12 @@ ignore = [
 max-args = 6
 
 [tool.ruff.lint.extend-per-file-ignores]
+"test/**.py" = [
+    "D",  # pydocstyle
+]
 "docs/**/*" = [
     "E402", # module level import not at top of file
+    "D",    # pydocstyle
 ]
 
 [tool.ruff.lint.flake8-copyright]
@@ -172,4 +176,7 @@ notice-rgx = """
 # that they have been altered from the originals\\.
 """
 
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
 [tool.typos.default.extend-words]
diff --git a/tox.ini b/tox.ini
@@ -29,7 +29,6 @@ commands =
   ruff check qiskit_addon_mpf/ docs/ test/
   ruff check --preview --select CPY001 --exclude "*.ipynb" qiskit_addon_mpf/ test/
   nbqa ruff docs/
-  pydocstyle qiskit_addon_mpf/
   mypy qiskit_addon_mpf/
   pylint -rn qiskit_addon_mpf/ test/
   nbqa pylint -rn docs/