Skip to content

Added interrogate docstring check to run-pre-commit.yml #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
JMP-MO wants to merge 5 commits into from
Closed

Added interrogate docstring check to run-pre-commit.yml #1

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8fa14a8
Added interrogate docstring check to run-pre-commit.yml
JMP-MO Apr 2, 2025
55a21d5
Update run-pre-commit.yml
JMP-MO Apr 2, 2025
38d7261
Update run-pre-commit.yml
JMP-MO Apr 2, 2025
438b7ab
Update run-pre-commit.yml
JMP-MO Apr 2, 2025
247de88
Update run-pre-commit.yml
JMP-MO Apr 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .github/workflows/run-pre-commit.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,21 @@ jobs:
run: |
python -m pip install --upgrade pip
pip install .[dev]

- name: Run docstring checks with interrogate
run: |
python -m pip install interrogate
interrogate -v --fail-under 40 --exclude "tests/*" --exclude "docs/*" --exclude "setup.py" --exclude "scripts/*" --exclude "examples/*" --exclude "*/__init__.py" --exclude "*/__main__.py" --output docstring-coverage.txt

- name: Upload docstring coverage
uses: actions/upload-artifact@v4
with:
name: docstring-coverage
path: docstring-coverage.txt

- name: pre-commit checks
run: |
pre-commit run black --all-files
# TODO enable once all cyclic imports have been fixed
# pre-commit run isort --all-files

Loading