You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by bl...@apache.org on 2023/06/05 23:52:49 UTC
[iceberg] branch master updated: Python: Add support for pydocstyle (#7772)
This is an automated email from the ASF dual-hosted git repository.
blue pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iceberg.git
The following commit(s) were added to refs/heads/master by this push:
new c591c26e5e Python: Add support for pydocstyle (#7772)
c591c26e5e is described below
commit c591c26e5e05158be635a35c5125293c70c86839
Author: Fokko Driesprong <fo...@apache.org>
AuthorDate: Tue Jun 6 01:52:42 2023 +0200
Python: Add support for pydocstyle (#7772)
This will make sure that our docstrings are properly formatted.
This is getting important since we also generate docs from the doc
strings. This PR is about adding the framework, and then we can follow
up in new PRs for each of the error codes.
---
python/.pre-commit-config.yaml | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/python/.pre-commit-config.yaml b/python/.pre-commit-config.yaml
index 1c4de6121e..02f947d5c2 100644
--- a/python/.pre-commit-config.yaml
+++ b/python/.pre-commit-config.yaml
@@ -85,3 +85,13 @@ repos:
- mdformat-admon
- mdformat-mkdocs
- mdformat-frontmatter
+ - repo: https://github.com/pycqa/pydocstyle
+ rev: 6.3.0
+ hooks:
+ - id: pydocstyle
+ args:
+ [
+ "--ignore=D100,D102,D101,D103,D104,D105,D106,D107,D200,D202,D203,D205,D209,D212,D213,D400,D401,D403,D404,D405,D406,D407,D411,D413,D414,D415,D417",
+ ]
+ additional_dependencies:
+ - tomli==2.0.1