:class:`VL011` ============== .. py:class:: src.ansys.pre_commit_hooks.quality_rules.vale.VL011 Bases: :py:obj:`Vale` Vale lints Python, Markdown, and reStructuredText files. .. !! processed by numpydoc !! .. py:currentmodule:: VL011 Overview -------- .. tab-set:: .. tab-item:: Static methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~check` - Check that styles apply to ``py``, ``md``, and ``rst`` files. Import detail ------------- .. code-block:: python from src.ansys.pre_commit_hooks.quality_rules.vale import VL011 Method detail ------------- .. py:method:: check(repository_root: pathlib.Path, readme_file: str | None) -> ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult :staticmethod: Check that styles apply to ``py``, ``md``, and ``rst`` files. :Returns: :ref:`bool ` or :class:`python:str` ``True`` when, for every extension, a glob section that sets ``BasedOnStyles`` matches it, otherwise a ``"WARNING: ..."`` message naming the uncovered extensions. .. !! processed by numpydoc !!