DOC021#

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

Bases: Documentation

The user-guide section contains documentation files.

Overview#

check

Recommend content when the user-guide section is empty or absent.

Import detail#

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

Method detail#

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

Recommend content when the user-guide section is empty or absent.