Ignore DOC errors for stub functions
#12651
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
charliermarsh
changed the title
DOC errors for stub functions
charliermarsh
force-pushed
the
charlie/DOC
branch
from
d5b3504 to
9eb597e
Compare
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| DOC202 | 10 | 0 | 10 | 0 | 0 |
MichaReiser
approved these changes
Aug 3, 2024
| return; | ||
| }; | ||
|
|
||
| // Only check function docstrings. | ||
| if matches!( |
There was a problem hiding this comment.
Is this check now covered by is_stub?
There was a problem hiding this comment.
It's covered by the
let Some(function_def) = definition.as_function_def() else {
return;
};immediately above
AlexWaygood
approved these changes
Aug 3, 2024
| if let Some(body_return) = body_entries.returns.first() { | ||
| let diagnostic = Diagnostic::new(DocstringMissingReturns, body_return.range()); | ||
| diagnostics.push(diagnostic); | ||
| if checker.enabled(Rule::DocstringMissingReturns) { |
There was a problem hiding this comment.
Is this change just a stylistic preference?
There was a problem hiding this comment.
Yeah, I prefer to have the enablement checks separated out from any lint-specific checks. I find it to be a clearer separation, and it would make it easier to identify and automatically rewrite them in the future.
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.
Summary
Closes #12650.