Ejf/improved spellcheck 4319 4320 #4330
Merged
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
|
@Pierre-Sassoulas - please let me know how this looks |
Pierre-Sassoulas
requested changes
Apr 9, 2021
pylint/checkers/spelling.py
Outdated
| @@ -308,9 +333,25 @@ def _check_spelling(self, msgid, line, line_num): | |||
| initial_space = 0 | |||
| if line.strip().startswith("#") and "docstring" not in msgid: | |||
| line = line.strip()[1:] | |||
| # A ``Filter`` cannot determine if the directive is at the beginning of a line, nor determine if a colon is present or not (``pyenchant`` strips trailing colons). So implementing this here. | |||
| for iter_directive in ( | |||
There was a problem hiding this comment.
This could be an option in the pylintrc, what do you think ?
There was a problem hiding this comment.
You mean the tuple of directives to ignore? If so, sure...but I've never worked with obtaining options from pylintrc before---is there a good spot in the codebase to look to get oriented to that?
There was a problem hiding this comment.
Oh, I see. it's just the .config. Yep, I think I can do that. I'll have it default to this pre-existing list if none is present in pylintrc if that's OK.
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
|
Thank you for implementing this check :) ! |
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.
Description
Skips spellchecking on code flanked in single or double backticks in comments/docstrings. Skips spellchecking on Python directives if and only if they are directly at the beginning of a comment (for tools such as black, flake8, zimports, isort, mypy, bandit, pycharm)
Type of Changes
Also some minor correcting to spelling errors in the code of spelling.py itself and minor refactor to remove some duplicate code (added the
RegExFilterparent class).Also, corrected a typo in the Changlog for 2.7.0 in an entry I submitted.
Related Issue
Closes #4319, #4320