DOC007#

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

Bases: Documentation

Gallery examples are recommended when a gallery extension is enabled.

Overview#

check

Check that enabled gallery extensions have example files configured.

Import detail#

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

Method detail#

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

Check that enabled gallery extensions have example files configured.