kaxil opened a new issue #10742: URL: https://github.com/apache/airflow/issues/10742
We use [PyDocStyle](https://github.com/PyCQA/pydocstyle) in pre-commit to enforce docstring style: https://github.com/apache/airflow/blob/7b810b81787a3d565cbfd499ae55ed926b97cb90/.pre-commit-config.yaml#L195-L203 We follow pep257 style (http://www.pydocstyle.org/en/stable/error_codes.html) for checks. Currently, we ignore the following rules: D100,D102,D104,D105,D107,D200,D202,D204,D205,D400,D401 **Missing Docstrings** -- D100 | Missing docstring in public module D102 | Missing docstring in public method D104 | Missing docstring in public package D105 | Missing docstring in magic method D107 | Missing docstring in __init__ **Whitespace Issues** -- D200 | One-line docstring should fit on one line with quotes D202 | No blank lines allowed after function docstring D204 | 1 blank line required after class docstring D205 | 1 blank line required between summary line and description **Docstring Content Issues** -- D400 | First line should end with a period D401 | First line should be in imperative mood It would be good if we can enable them one by one -- separate PRs are ok Let me know if you need any help ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
