diff --git a/poetry.lock b/poetry.lock index 2761102..c96a094 100644 --- a/poetry.lock +++ b/poetry.lock @@ -718,6 +718,26 @@ docs = ["myst-parser (==0.18.0)", "sphinx (==5.1.1)"] ssh = ["paramiko (>=2.4.3)"] websockets = ["websocket-client (>=1.3.0)"] +[[package]] +name = "docstr-coverage" +version = "2.3.2" +description = "Utility for examining python source files to ensure proper documentation. Lists missing docstrings, and calculates overall docstring coverage percentage rating." +optional = false +python-versions = "*" +files = [ + {file = "docstr-coverage-2.3.2.tar.gz", hash = "sha256:e99a28c502ed21ae8a310cb9e14e8de2d7cff44d365b46fa6dca6de05bf156a0"}, + {file = "docstr_coverage-2.3.2-py3-none-any.whl", hash = "sha256:37a885d6560ad87e289b23bf0e54527885bacbf6b17cf55278d514dd0fef8ff5"}, +] + +[package.dependencies] +click = "*" +PyYAML = "*" +tqdm = "*" + +[package.extras] +lint = ["black (==22.3.0)", "flake8 (==4.0.1)", "isort (==5.10.1)"] +test = ["pytest (==6.2.5)", "pytest-mock (==3.4.0)"] + [[package]] name = "dtreeviz" version = "2.2.2" @@ -3792,4 +3812,4 @@ xgboost = ["xgboost"] [metadata] lock-version = "2.0" python-versions = "^3.9" -content-hash = "f99b644e00de89acab772e163643f604d7b398546cad6e7e540094d6e62e686e" +content-hash = "c5f5339142f4bd117afd2464e6698209dd6d431164027eb06701c604feaced0c" diff --git a/pyproject.toml b/pyproject.toml index e478a21..bb695a3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -32,6 +32,7 @@ memray = "^1.13.1" pyinstrument = "^4.6.2" pytest = "^8.2.2" ruff = "^0.3.0" +docstr-coverage = "^2.3.2" [build-system] requires = ["poetry-core"]