Set up automated docstring coverage checks

NVIDIA-Merlin · Mar 7, 2022 · 892b9fd · 892b9fd
1 parent ee1d59d
commit 892b9fd
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/.github/workflows/cpu-ci.yml b/.github/workflows/cpu-ci.yml
@@ -42,6 +42,9 @@ jobs:
     - name: Lint with isort
       run: |
         isort -c .
+    - name: Lint with interrogate
+      run: |
+        interrogate -viImMpPsSCn -f 39.9 merlin
     - name: Lint with codespell
       run: |
         codespell

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -17,6 +17,11 @@ repos:
         rev: pylint-2.7.4
         hooks:
         - id: pylint
+      - repo: https://github.com/econchick/interrogate
+        rev: 1.5.0
+        hooks:
+        - id: interrogate
+          args: [-viImMpPsSCn, -f, "39.9", merlin]
       - repo: https://github.com/codespell-project/codespell
         rev: v2.1.0
         hooks:

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -6,6 +6,7 @@ flake8==3.9.2
 isort==5.9.3
 pylint==2.7.4
 bandit==1.7.0
+interrogate==1.5.0
 pytest>=5
 pytest-cov>=2
 pytest-xdist