DOC020#

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

Bases: Documentation

The getting-started section contains documentation files.

Overview#

check

Recommend content when the getting-started section is empty or absent.

Import detail#

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

Method detail#

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

Recommend content when the getting-started section is empty or absent.