This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
Change appropriate "Nested" definitions into "Inaccessible", and add new codes #561
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
thejcannon
commented
Nov 23, 2021
There was a problem hiding this comment.
I couldn't find a good term after scouring python.org for what this might be called. I wanted to avoid "nested" because that exists for classes. "Inner" also didn't feel correct because methods are inside classes. I landed on "inaccessible" because the caller can't access them.
| @@ -183,6 +183,7 @@ class ConfigurationParser: | |||
| ) | |||
| BASE_ERROR_SELECTION_OPTIONS = ('ignore', 'select', 'convention') | |||
|
|
|||
| DEFAULT_IGNORE = {"D121", "D123"} | |||
There was a problem hiding this comment.
Other tools have this kind of "we have the ability to report these codes, but their off by default" functionality. I figured this belonged to that category. Note if people are selecting ignores today, this will no longer be the default.
thejcannon
commented
Nov 23, 2021
thejcannon
commented
Nov 23, 2021
2 tasks
thejcannon
commented
Nov 23, 2021
|
@samj1912 this should be ready to review 😄 |
|
@samj1912 got time for a quick review? |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Some devs want to be able to ignore inaccessible definitions, and some might want to not. This should allow them the option to choose.
(This also helps keep the definition of
is_publicpure and straightforward and correct according to the documentation)Please make sure to check for the following items: