DOC019#

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

Bases: Documentation

The changelog root page exists.

Overview#

check

Recommend the changelog root page when it is missing.

Import detail#

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

Method detail#

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

Recommend the changelog root page when it is missing.