From 667de5ca9714008083652b0813156f29507151c5 Mon Sep 17 00:00:00 2001
From: "Leandro G. Almeida" <leandro.g.almeida@gmail.com>
Date: Fri, 22 Nov 2024 17:24:58 -0800
Subject: [PATCH] add interrogate check

---
 CONTRIBUTING.md         |  8 ++++----
 Makefile                | 31 ++++++++++++++++++++-----------
 config/interrogate.toml | 22 ++++++++++++++++++++++
 config/ruff.toml        |  1 +
 pyproject.toml          |  2 --
 5 files changed, 47 insertions(+), 17 deletions(-)
 create mode 100644 config/interrogate.toml

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index fe4bb9e5..3400045c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -189,8 +189,7 @@ We will then review the changes and review next steps for adding the dataset int
 
 
 ### Installing uv
-
-Install uv follow the guidelines in  https://docs.astral.sh/uv/getting-started/installation/, it is recommended to use the standalone installation.
+Dependencies and admin actions are done using `uv`. To Install uv follow the guidelines in  https://docs.astral.sh/uv/getting-started/installation/, it is recommended to use the standalone installation.
 
 
 ### Building Project
@@ -206,7 +205,8 @@ To sync the dependencies simply run:
 ```
 uv sync
 ```
-### Running test
+
+### Running tests
 
 ```
 make test
@@ -214,7 +214,7 @@ make test
 
 ### Running scripts
 
-For running scripts or one using the project's e
+For running scripts or one-offs using the project's installed enviroment
 
 ```
 uv run python <script>
diff --git a/Makefile b/Makefile
index 74cb690d..7edf75d1 100644
--- a/Makefile
+++ b/Makefile
@@ -10,7 +10,6 @@ dist.dir := dist
 build.wheel := $(dist.dir)/agml-$(version).tar.gz
 
 
-
 .PHONY: help
 help: ## Print the help screen.
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":|:[[:space:]].*?##"}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
@@ -25,24 +24,34 @@ test: $(test.python) $(src.python) ## Run tests
 	uv run pytest -c=config/pytest.ini $(test.python)
 
 
-.PHONY: format
-format: ## Run ruff format (Includes sorting of imports)
-	uv run ruff check --select I --config=config/ruff.toml --fix
-	uv run ruff format --config=config/ruff.toml $(src.python) $(test.python)
+# Quality Checks
+
+.PHONY: check-types
+check-types: ## Run mypy to check type definitions.
+	uv run mypy --config=config/mypy.ini $(src.python) $(test.python)
+
 
 .PHONY: check-format
 check-format: ## Check ruff format
 	uv run ruff format --check --config=config/ruff.toml $(src.python) $(test.python)
 
 
+.PHONY: lint
+lint: ## Run ruff Code Linter
+	uv run ruff check --config=config/ruff.toml $(src.python) $(test.python)
+
+.PHONY:docstring-coverage
+docstring-coverage: ## Compute docstring coverage
+	uv run interrogate -c config/interrogate.toml .
+
+# Quality fixes
+
 .PHONY: lint-fix
 lint-fix: ## Fix ruff Lint issues
 	uv run ruff check --fix --config=config/ruff.toml $(src.python) $(test.python)
 
-.PHONY: lint
-lint: ## Run ruff Code Linter
-	uv run ruff check --config=config/ruff.toml $(src.python) $(test.python)
 
-.PHONY: check-types
-check-types: ## Run mypy to check type definitions.
-	uv run mypy --config=config/mypy.ini $(src.python) $(test.python)
+.PHONY: format
+format: ## Run ruff format (Includes sorting of imports)
+	uv run ruff check --select I --config=config/ruff.toml --fix
+	uv run ruff format --config=config/ruff.toml $(src.python) $(test.python)
diff --git a/config/interrogate.toml b/config/interrogate.toml
new file mode 100644
index 00000000..7465152f
--- /dev/null
+++ b/config/interrogate.toml
@@ -0,0 +1,22 @@
+[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 = true
+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 = 3
+quiet = false
+whitelist-regex = []
+color = true
+omit-covered-files = false
+generate-badge = "interrogate_badge.svg"
+badge-format = "svg"
diff --git a/config/ruff.toml b/config/ruff.toml
index 3a254768..ef38ac6d 100644
--- a/config/ruff.toml
+++ b/config/ruff.toml
@@ -79,6 +79,7 @@ docstring-code-format = false
 docstring-code-line-length = "dynamic"
 
 [lint.isort]
+
 case-sensitive = true
 default-section = "third-party"
 known-first-party = ["agml"]
diff --git a/pyproject.toml b/pyproject.toml
index d2561405..19e707f4 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -35,8 +35,6 @@ classifiers = [
     "Typing :: Typed",
 ]
 
-
-
 # managed by uv
 dependencies = [
     "matplotlib>=3.7.5",