:class:`DOC028` =============== .. py:class:: src.ansys.pre_commit_hooks.quality_rules.documentation.DOC028 Bases: :py:obj:`Documentation` The interrogate hook checks docstring coverage. .. !! processed by numpydoc !! .. py:currentmodule:: DOC028 Overview -------- .. tab-set:: .. tab-item:: Static methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~check` - Recommend the interrogate pre-commit hook when it is not configured. Import detail ------------- .. code-block:: python from src.ansys.pre_commit_hooks.quality_rules.documentation import DOC028 Method detail ------------- .. py:method:: check(repository_root: pathlib.Path, readme_file: str | None) -> ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult :staticmethod: Recommend the interrogate pre-commit hook when it is not configured. .. !! processed by numpydoc !!