DOC010#

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

Bases: Documentation

Site author, copyright, and CNAME metadata are configured.

Overview#

check

Recommend complete author, copyright, and CNAME metadata.

Import detail#

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

Method detail#

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

Recommend complete author, copyright, and CNAME metadata.