:class:`VL002` ============== .. py:class:: src.ansys.pre_commit_hooks.quality_rules.vale.VL002 Bases: :py:obj:`Vale` Vale uses the Google style package. .. !! processed by numpydoc !! .. py:currentmodule:: VL002 Overview -------- .. tab-set:: .. tab-item:: Static methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~check` - Check that Google is both installed and applied. Import detail ------------- .. code-block:: python from src.ansys.pre_commit_hooks.quality_rules.vale import VL002 Method detail ------------- .. py:method:: check(repository_root: pathlib.Path, readme_file: str | None) -> ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult :staticmethod: Check that Google is both installed and applied. :Returns: :ref:`bool ` or :class:`python:str` ``True`` when ``Packages`` lists Google and a ``BasedOnStyles`` setting applies it, otherwise an ``"ERROR: ..."`` message. .. !! processed by numpydoc !!