Add docformatter pre-commit hook + fix failing docstrings

Author: nathanpainchaud

.pre-commit-config.yaml

@@ -25,6 +25,13 @@ repos:
         args: [--fix]
       - id: ruff-format
 
+  # python docstring formatting
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.7.8
+    hooks:
+      - id: docformatter
+        args: [--in-place]
+
   # jupyter notebook cell output clearing
   - repo: https://github.com/kynan/nbstripout
     rev: 0.9.1

pyproject.toml

@@ -3,3 +3,8 @@ line-length = 120
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"
+
+[tool.docformatter]
+recursive = true
+wrap-summaries=120
+wrap-descriptions=120

src/data/transforms.py

@@ -4,7 +4,7 @@
 
 
 class NormalizeSample(torch.nn.Module):
-    """Normalize a tensor image w.r.t. to its mean and standard deviation.
+    """Normalize a tensor image with respect to its mean and standard deviation.
 
     Args:
         inplace: Whether to make this operation in-place.