DOC022#

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

Bases: Documentation

The API section contains documentation files.

Overview#

check

Recommend content when the API section is empty or absent.

Import detail#

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

Method detail#

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

Recommend content when the API section is empty or absent.