-
Notifications
You must be signed in to change notification settings - Fork 903
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add sphinx documentation style to pydocstyle config #6606
Comments
We can probably add a convention that's compatible, but there would also be necessary work to actually support parsing Sphinx docstrings (e.g., PyCQA/pydocstyle#595). pydocstyle itself does not support this. |
Alright, so as far as I know, the necessary pull requests to pydocstyle have been made as of 5 hours ago. Relevant commit here: PyCQA/pydocstyle/commit. |
Related, it would be nice to get a check when a different convention is used. |
(Removing |
Sounds great! Let me know if there's anything I can do to help. |
+1 on this feature. Any updates on sphinx support? |
Ditto @winwinashwin. We would adopt Ruff immediately on this project it there was sphinx support. Unfortunately, we have a code base full of Sphinx style docstrings and need to implement linting on them. |
Hi, just checking if/when this will be available? BTW thanks for making this super awesome tool! |
Addition of sphinx documentation style to pydocstyle config as so:
Currently pep257, google, and numpy documentation styles are supported. It'd be nice to have this major documentation style added as well.
The text was updated successfully, but these errors were encountered: