VL002#

class src.ansys.pre_commit_hooks.quality_rules.vale.VL002#

Bases: Vale

Vale uses the Google style package.

Overview#

check

Check that Google is both installed and applied.

Import detail#

from src.ansys.pre_commit_hooks.quality_rules.vale import VL002

Method detail#

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

Check that Google is both installed and applied.

Returns:
bool or str

True when Packages lists Google and a BasedOnStyles setting applies it, otherwise an "ERROR: ..." message.