DOC030#

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

Bases: Documentation

A cheatsheet is added to the documentation.

Overview#

check

Recommend adding a cheatsheet to the documentation.

Import detail#

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

Method detail#

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

Recommend adding a cheatsheet to the documentation.