Vale#
- class src.ansys.pre_commit_hooks.quality_rules.vale.Vale#
Bases:
abc.ABCVale rule family.
Base class of the Vale quality rules. Each rule is a subclass named
VLwith a staticcheckmethod that evaluates the documentation Vale configuration independently. Missing or unreadable configuration is reported as an error rather than skipped.
Overview#
Import detail#
from src.ansys.pre_commit_hooks.quality_rules.vale import Vale
Attribute detail#
Method detail#
- static Vale.check(repository_root: pathlib.Path, readme_file: str | None) ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult#
- Abstractmethod:
Evaluate a Vale rule.
- Parameters:
- repository_root
pathlib.Path Repository root directory.
- readme_file
strorNone Detected README path, unused by this rule family.
- repository_root
- Returns: