VL007#

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

Bases: Vale

Vale MinAlertLevel is warning or stricter.

Overview#

check

Check that MinAlertLevel hides suggestions only.

Import detail#

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

Method detail#

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

Check that MinAlertLevel hides suggestions only.

Returns:
bool or str

True for warning or error, otherwise a "WARNING: ..." message. An unset value counts as Vale’s suggestion default.