DOC024#

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

Bases: Documentation

The contribute section contains documentation files.

Overview#

check

Recommend content when the contribute section is empty or absent.

Import detail#

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

Method detail#

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

Recommend content when the contribute section is empty or absent.