Skip to content

Commit

Permalink
Add interrogate workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
thomaspinder authored Sep 1, 2024
1 parent be7212c commit e7a35f8
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 1 deletion.
28 changes: 28 additions & 0 deletions .github/workflows/interrogate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Docstrings

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
Workflow:
runs-on: ubuntu-latest
steps:
- name: Clone the reference repository
uses: actions/checkout@v

- name: Set up Python 3.10.6
uses: actions/setup-python@v2
with:
python-version: '3.10.6'

- name: Install dependencies
run: |
pip install -e '.[dev]'
- name: Run docstring checks
run: interrogate -vv dynamax --fail-under 66
10 changes: 9 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,12 @@
requires = ["setuptools >= 30.3.0", "wheel"]

[tool.black]
line-length = 120
line-length = 120

[tool.interrogate]
ignore-init-method = true
ignore-init-module = true
fail-under = 66
verbose = 2
quiet = false
color = true
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ test =
coverage
pytest>=3.9
pytest-cov
interrogate>=1.5.0

# A combination of dependencies required for developers
dev =
Expand Down

0 comments on commit e7a35f8

Please sign in to comment.