Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Perform markup validation of docstrings, e.g. reStructuredText #245

Closed
peterjc opened this issue Apr 6, 2017 · 3 comments
Closed

Perform markup validation of docstrings, e.g. reStructuredText #245

peterjc opened this issue Apr 6, 2017 · 3 comments

Comments

@peterjc
Copy link
Contributor

peterjc commented Apr 6, 2017

This is an enhancement suggestion / wish list item.

I would like to be able to validate the markup used in Python docstrings, specifically as reStructuredText (aka RST, which as per PEP287 https://www.python.org/dev/peps/pep-0287/ is recommended), but others might want to use e.g. markdown.

Cross-reference restructuredtext-lint question twolfson/restructuredtext-lint#34

@peterjc
Copy link
Contributor Author

peterjc commented Jun 7, 2017

As per the discussion on #254, the pydocstyle team currently would prefer this be a new plugin for flake8 - see https://gitlab.com/pycqa/flake8/issues/337

(I propose to leave this issue open until such a plugin exists)

@peterjc
Copy link
Contributor Author

peterjc commented Jun 15, 2017

I've started working on this as a flake8 plugin under the name flake8-rst-docstrings,

https://github.com/peterjc/flake8-rst-docstrings

@peterjc
Copy link
Contributor Author

peterjc commented Jun 16, 2017

I've made the first release of the new plugin flake8-rst-docstrings on PyPI:

https://pypi.python.org/pypi/flake8-rst-docstrings

Unless there is a good place to mention this in the pydocstyle documentation, this issue can be closed.

@Nurdok Nurdok closed this as completed Jun 17, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants