DOC026#
- class src.ansys.pre_commit_hooks.quality_rules.documentation.DOC026#
Bases:
DocumentationThe documentarian contributor guide is recommended.
Overview#
Recommend adding the documentarian contributor guide when it is missing. |
Import detail#
from src.ansys.pre_commit_hooks.quality_rules.documentation import DOC026
Method detail#
- static DOC026.check(repository_root: pathlib.Path, readme_file: str | None) ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult#
Recommend adding the documentarian contributor guide when it is missing.