diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e768126d11c..291b8b78176 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -166,6 +166,25 @@ repos: ?.pb\.(cc|h)$| ?^cpp/src/generated/| ) + - repo: https://github.com/numpy/numpydoc + rev: v1.8.0 + hooks: + - id: numpydoc-validation + name: Python (NumPy doc) Lint + alias: python-doc-lint + args: + - "--config=python" + files: >- + ^python/pyarrow/ + exclude: >- + ( + ?^python/pyarrow/interchange/from_dataframe\.py$| + ?^python/pyarrow/jvm\.py$| + ?^python/pyarrow/pandas_compat\.py$| + ?^python/pyarrow/tests/| + ?^python/pyarrow/util\.py$| + ?^python/pyarrow/vendored/| + ) - repo: local hooks: - id: lintr diff --git a/python/pyproject.toml b/python/pyproject.toml index 778e3508be1..b573b8843e7 100644 --- a/python/pyproject.toml +++ b/python/pyproject.toml @@ -65,6 +65,21 @@ test = [ 'pandas' ] +[tool.numpydoc_validation] +checks = [ + "GL10", + "PR01", + "PR03", + "PR04", + "PR05", + "PR10", + "RT03", + "YD01", +] +exclude = [ + '\._.*$', +] + [tool.setuptools] zip-safe=false include-package-data=true