Configure docformatter

VWS-Python · Oct 8, 2024 · 8bbc606 · 8bbc606
1 parent 90b75cf
commit 8bbc606
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -49,9 +49,9 @@ repos:
         types_or: [yaml]
         additional_dependencies: ["uv"]
 
-      - id: docformatter
-        name: docformatter
-        entry: uv run --extra=dev -m docformatter
+      - id: docformatter --in-place
+        name: docformatter --in-place
+        entry: uv run --extra=dev -m docformatter --in-place
         language: python
         types_or: [python]
         additional_dependencies: ["uv"]
@@ -283,9 +283,9 @@ ci:
     - ruff-check-fix-docs
     - ruff-format-fix
     - ruff-format-fix-docs
-    - docformatter
+    - docformatter --in-place
     - shellcheck
-    - docformatter
+    - docformatter --in-place
     - shellcheck-docs
     - shfmt
     - shfmt-docs

diff --git a/pyproject.toml b/pyproject.toml
@@ -67,7 +67,7 @@ optional-dependencies.dev = [
     "types-requests==2.32.0.20240914",
     "vulture==2.13",
     "vws-python-mock==2024.8.30",
-    "docformatter==1.7.5",
+    "docformatter --in-place==1.7.5",
 ]
 optional-dependencies.release = [ "check-wheel-contents==0.6.0" ]
 urls.Source = "https://github.com/VWS-Python/vws-auth-tools"
@@ -241,6 +241,9 @@ spelling-private-dict-file = 'spelling_private_dict.txt'
 # --spelling-private-dict-file option instead of raising a message.
 spelling-store-unknown-words = 'no'
 
+[tool.docformatter]
+make-summary-multi-line = true
+
 [tool.check-manifest]
 
 ignore = [