Merge pull request #124 from pymc-labs/interrogate

use interrogate to assess docstring coverage

Author: drbenvincent

.github/workflows/ci.yml

@@ -19,6 +19,7 @@ jobs:
         run: |
           make init
           make check_lint
+
   test:
     runs-on: ubuntu-latest
     strategy:

.pre-commit-config.yaml

@@ -33,3 +33,10 @@ repos:
           args: ["--py37-plus"]
         - id: nbqa-isort
           args: ["--float-to-top"]
+    - repo: https://github.com/econchick/interrogate
+      rev: 1.5.0
+      hooks:
+          - id: interrogate
+            # needed to make excludes in pyproject.toml work
+            # see here https://github.com/econchick/interrogate/issues/60#issuecomment-735436566
+            pass_filenames: false

Makefile

@@ -15,6 +15,7 @@ check_lint:
 	black --diff --check --fast .
 	nbqa black --check .
 	nbqa isort --check-only .
+	interrogate .
 
 test:
 	pip install -r requirements-test.txt

README.md

@@ -6,6 +6,7 @@
 ![GitHub Repo stars](https://img.shields.io/github/stars/pymc-labs/causalpy?style=social)
 ![Read the Docs](https://img.shields.io/readthedocs/causalpy)
 ![PyPI - Downloads](https://img.shields.io/pypi/dm/causalpy)
+![Interrogate](img/interrogate_badge.svg)
 
 A Python package focussing on causal inference in quasi-experimental settings. The package allows for sophisticated Bayesian model fitting methods to be used in addition to traditional OLS.
 

img/interrogate_badge.svg

@@ -14,3 +14,26 @@ markers = [
     "integration: mark as an integration test.",
     "slow: mark test as slow.",
     ]
+
+[tool.interrogate]
+ignore-init-method = true
+ignore-init-module = true
+ignore-magic = false
+ignore-semiprivate = false
+ignore-private = false
+ignore-property-decorators = false
+ignore-module = false
+ignore-nested-functions = false
+ignore-nested-classes = true
+ignore-setters = false
+fail-under = 40
+exclude = ["setup.py", "docs", "build"]
+ignore-regex = ["^get$", "^mock_.*", ".*BaseClass.*"]
+# possible values: 0 (minimal output), 1 (-v), 2 (-vv)
+verbose = 1
+quiet = false
+whitelist-regex = []
+color = true
+omit-covered-files = false
+generate-badge = "img"
+badge-format = "svg"

pyproject.toml

@@ -1,3 +1,4 @@
 pathlib
 pre-commit
 twine
+interrogate

requirements-dev.txt

@@ -1,5 +1,6 @@
 black>=22.3.0
 flake8>=4.0.1
+interrogate>=1.5.0
 isort>=5.10.1
 nbqa>=1.5.3
 pre-commit>=2.19.0