DOC028#

class src.ansys.pre_commit_hooks.quality_rules.documentation.DOC028#

Bases: Documentation

The interrogate hook checks docstring coverage.

Overview#

check

Recommend the interrogate pre-commit hook when it is not configured.

Import detail#

from src.ansys.pre_commit_hooks.quality_rules.documentation import DOC028

Method detail#

static DOC028.check(repository_root: pathlib.Path, readme_file: str | None) → ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult#

Recommend the interrogate pre-commit hook when it is not configured.