Skip to content
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

Possible extension: checking Python docstrings are valid RST #156

Open
peterjc opened this issue Mar 20, 2024 · 0 comments
Open

Possible extension: checking Python docstrings are valid RST #156

peterjc opened this issue Mar 20, 2024 · 0 comments

Comments

@peterjc
Copy link
Contributor

peterjc commented Mar 20, 2024

I wanted to ask if this idea might be considered in scope for doc8: Parsing Python source code (*.py), extracting the docstrings, and validating those as RST.

i.e. Something equivalent to the functionality my plugin https://github.com/peterjc/flake8-rst-docstrings brings to flake8. Internally this takes the AST of a Python file, and passes the docstrings to docutils for validation via restructuredtext_lint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant