Add some known Sphinx roles and directives #8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
$ flake8 tests/test_cases/sphinx-py.py tests/test_cases/sphinx-py.py:8:1: RST303 Unknown directive type "py:function". tests/test_cases/sphinx-py.py:26:1: RST304 Unknown interpreted text role "class". tests/test_cases/sphinx-py.py:28:1: RST304 Unknown interpreted text role "py:class".
From the std, rst and py domains. See also http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html TODO: Allow these lists to be altered via flake8 preferences
|
Rebasing for changes to adopt |
|
Good news - I now understand how to set flake8 plugin settings, see e.g. https://github.com/peterjc/flake8-black/blob/master/flake8_black.py |
|
See discussion on #7, I will not add a hard coded list. Rather, new configuration setting(s) for users to add their own list of roles/directives to be ignored seems best (default an empty list). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a possible step towards solving #7, but not being a heavy Sphinx user (yet), I am unsure if it goes far enough? Feedback welcome.
With this change, will not raise
RST303andRST304for a hard coded list of Sphinx roles and directives fromstd,rstandpydomains (e.g.:py:class:or:class:).