:class:`DOC003` =============== .. py:class:: src.ansys.pre_commit_hooks.quality_rules.documentation.DOC003 Bases: :py:obj:`Documentation` Numpydoc is enabled for NumPy-style API documentation. .. !! processed by numpydoc !! .. py:currentmodule:: DOC003 Overview -------- .. tab-set:: .. tab-item:: Static methods .. list-table:: :header-rows: 0 :widths: auto * - :py:attr:`~check` - Recommend numpydoc for rendering NumPy-style API documentation. Import detail ------------- .. code-block:: python from src.ansys.pre_commit_hooks.quality_rules.documentation import DOC003 Method detail ------------- .. py:method:: check(repository_root: pathlib.Path, readme_file: str | None) -> ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult :staticmethod: Recommend numpydoc for rendering NumPy-style API documentation. .. !! processed by numpydoc !!