VL011#

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

Bases: Vale

Vale lints Python, Markdown, and reStructuredText files.

Overview#

check

Check that styles apply to py, md, and rst files.

Import detail#

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

Method detail#

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

Check that styles apply to py, md, and rst files.

Returns:
bool or str

True when, for every extension, a glob section that sets BasedOnStyles matches it, otherwise a "WARNING: ..." message naming the uncovered extensions.