DOC013#

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

Bases: Documentation

Authored RST filenames use lowercase letters and hyphens.

Overview#

check

Reject authored RST filenames with uppercase letters or underscores.

Import detail#

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

Method detail#

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

Reject authored RST filenames with uppercase letters or underscores.