docs: Refactor pycodestyle/Flake8 compatibility docs #4194
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
cobaltt7
changed the title
Signed-off-by: RedGuy12 <61329810+RedGuy12@users.noreply.github.com>
Signed-off-by: RedGuy12 <61329810+RedGuy12@users.noreply.github.com>
cobaltt7
commented
Jan 31, 2024
There was a problem hiding this comment.
@JelleZijlstra I've made the requested changes. My thought process for some of the changes:
- I updated the
compatible_configsfolder (and added some for pycodestyle). This was an oversight in Document disabling E704 #3888. Not sure how useful this folder is, but I didn't think removing it would be in scope here. - It turns out that
E704is already disabled by default, so Document disabling E704 #3888 actually didn't document it correctly. Fixed that here. - I moved the pycodestyle section above Flake8 and moved the reasoning section there as well. Since Flake8 is a wrapper around pycodestyle, I felt like it made more sense to have the bulk of the docs in the pycodestyle section instead of under Flake8.
- The Bugbear information was previously only in current_style.md. I moved it to using_black_with_other_tools.md, and added a link in current_style.md and in the FAQ.
hauntsaninja
added
the
skip news
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
for more information, see https://pre-commit.ci
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Signed-off-by: RedGuy12 <61329810+RedGuy12@users.noreply.github.com>
Signed-off-by: RedGuy12 <61329810+RedGuy12@users.noreply.github.com>
| @@ -0,0 +1,3 @@ | |||
| [pycodestyle] | |||
| max-line-length = 88 | |||
| ignore = E203,E701 | |||
There was a problem hiding this comment.
pycodestyle does not read the .flake8 config file
this configuration also will result in quite a lot of frustration as it enables several pairs of incompatible codes
There was a problem hiding this comment.
whoops, that looks it was my bad; the black docs do have the correct formats listed
what further incompatible codes need to be disabled?
There was a problem hiding this comment.
personally I would include (at least) all of the disabled-by-default codes
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
Resolves #4173
Related to #3888
Checklist - did you ...
CHANGES.mdif necessary?