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