DOC003#
- class src.ansys.pre_commit_hooks.quality_rules.documentation.DOC003#
Bases:
DocumentationNumpydoc is enabled for NumPy-style API documentation.
Overview#
Recommend numpydoc for rendering NumPy-style API documentation. |
Import detail#
from src.ansys.pre_commit_hooks.quality_rules.documentation import DOC003
Method detail#
- static DOC003.check(repository_root: pathlib.Path, readme_file: str | None) ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult#
Recommend numpydoc for rendering NumPy-style API documentation.