nchammas commented on a change in pull request #27912: [SPARK-31155] Enable
pydocstyle tests
URL: https://github.com/apache/spark/pull/27912#discussion_r392602848
##########
File path: dev/tox.ini
##########
@@ -18,4 +18,4 @@ ignore=E226,E241,E305,E402,E722,E731,E741,W503,W504
max-line-length=100
exclude=cloudpickle.py,heapq3.py,shared.py,python/docs/conf.py,work/*/*.py,python/.eggs/*,dist/*,.git/*
[pydocstyle]
-ignore=D100,D101,D102,D103,D104,D105,D106,D107,D200,D201,D202,D203,D204,D205,D206,D207,D208,D209,D210,D211,D212,D213,D214,D215,D300,D301,D302,D400,D401,D402,D403,D404,D405,D406,D407,D408,D409,D410,D411,D412,D413,D414
+ignore=D100,D101,D102,D103,D104,D105,D106,D107,D200,D201,D202,D203,D204,D205,D206,D207,D208,D209,D210,D211,D212,D213,D214,D215,D300,D301,D302,D400,D401,D402,D403,D404,D405,D406,D407,D408,D409,D410,D411,D412,D413,D414,D415,D416,D417
Review comment:
I had to add these new ignore rules because, presumably, when pydocstyle was
last run it was at an older version that didn't implement these checks.
Here's an example of each:
```
./sql/gen-sql-api-docs.py:121 in private function `_make_pretty_note`:
D415: First line should end with a period, question mark, or
exclamation point (not 't')
./sql/gen-sql-api-docs.py:163 in public function `generate_sql_markdown`:
D416: Section name should end with a colon ('Arguments:', not
'ARGUMENTS')
./sql/gen-sql-api-docs.py:163 in public function `generate_sql_markdown`:
D417: Missing argument descriptions in the docstring (argument(s)
jvm, path are missing descriptions in 'generate_sql_markdown' docstring)
```
Honestly, the list of disabled pydocstyle tests is so long I wonder why we
have the thing at all! 😆
Perhaps in a separate PR we can start fixing some of these issues and
reenable the various checks. But I imagine the changes will touch every
docstring we have.
----------------------------------------------------------------
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:
[email protected]
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
