PM001

class src.ansys.pre_commit_hooks.quality_rules.project_metadata.PM001

Bases: ProjectMetadata

The AUTHORS file exists.

Overview

Static methods

check

Return whether the AUTHORS file is present.

Import detail

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

Method detail

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

Return whether the AUTHORS file is present.