PM017#

class src.ansys.pre_commit_hooks.quality_rules.project_metadata.PM017#

Bases: ProjectMetadata

The project includes a docs directory.

Overview#

check

Return whether a documentation directory is present.

Import detail#

from src.ansys.pre_commit_hooks.quality_rules.project_metadata import PM017

Method detail#

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

Return whether a documentation directory is present.