Add flake8 and pydocstyle to precommit

scikit-learn-contrib · Nov 25, 2024 · ad5972d · ad5972d
1 parent 83ee6e8
commit ad5972d
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/.github/workflows/deploy-pypi.yml b/.github/workflows/deploy-pypi.yml
@@ -27,7 +27,7 @@ jobs:
     - name: Test with pytest
       run: |
         flake8
-        pydocstyle
+        pydocstyle hiclass tests
         pytest -v --cov=hiclass --cov-fail-under=90 --cov-report html
         coverage xml
     - name: Upload Coverage to Codecov

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -9,3 +9,12 @@ repos:
     rev: 24.2.0
     hooks:
       - id: black
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.1.1
+    hooks:
+      - id: flake8
+  - repo: https://github.com/pycqa/pydocstyle
+    rev: 6.3.0
+    hooks:
+    - id: pydocstyle
+      files: ^hiclass/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -19,7 +19,7 @@ pip install -e ".[dev]"
 To run the tests simply execute:
 
 ```
-pytest -v --flake8 --pydocstyle --cov=hiclass --cov-fail-under=90 --cov-report html
+pytest -v --cov=hiclass --cov-fail-under=90 --cov-report html
 ```
 
 Lastly, you can set up the git hooks scripts to fix formatting errors locally during commits: