:class:`DOC025` =============== .. py:class:: src.ansys.pre_commit_hooks.quality_rules.documentation.DOC025 Bases: :py:obj:`Documentation` The user contributor guide is recommended. .. !! processed by numpydoc !! .. py:currentmodule:: DOC025 Overview -------- .. tab-set:: .. tab-item:: Static methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~check` - Recommend adding the user contributor guide when it is missing. Import detail ------------- .. code-block:: python from src.ansys.pre_commit_hooks.quality_rules.documentation import DOC025 Method detail ------------- .. py:method:: check(repository_root: pathlib.Path, readme_file: str | None) -> ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult :staticmethod: Recommend adding the user contributor guide when it is missing. .. !! processed by numpydoc !!