Fix a false positive for missing-param-doc
#9740
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
mbyrnepr2
added
the
False Positive π¦
mbyrnepr2
force-pushed
the
9739_missing_param_doc
branch
from
cd813b4
to
05896fa
Compare
This comment has been minimized.
This comment has been minimized.
β¦s decorated with ``typing.overload`` was expected to have a docstring specifying its parameters. Closes pylint-dev#9739
mbyrnepr2
force-pushed
the
9739_missing_param_doc
branch
from
05896fa
to
cae03f1
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Codecov ReportAll modified and coverable lines are covered by tests β
Additional details and impacted files@@ Coverage Diff @@
## main #9740 /- ##
==========================================
- Coverage 95.85% 95.80% -0.06%
==========================================
Files 174 174
Lines 18873 18885 12
==========================================
Hits 18090 18092 2
- Misses 783 793 10
|
This comment has been minimized.
This comment has been minimized.
|
Sorry I was using the "open close" principle to trigger the codecov run since there was an issue on a previous run :D |
jacobtylerwalls
force-pushed
the
9739_missing_param_doc
branch
from
e815a7f
to
cae03f1
Compare
|
Sorry for the noise -- committed to the wrong branch. π . Thanks Mark! |
This comment has been minimized.
This comment has been minimized.
Co-authored-by: Jacob Walls <[email protected]>
|
π€ According to the primer, this change has no effect on the checked open source code. π€π This comment was generated for commit 1c5289b |
jacobtylerwalls
approved these changes
Jul 15, 2024
jacobtylerwalls
pushed a commit
that referenced
this pull request
Jul 15, 2024
* Fix a false positive for ``missing-param-doc`` where a method which is decorated with ``typing.overload`` was expected to have a docstring specifying its parameters. Closes #9739 (cherry picked from commit 9cd5c37) Co-authored-by: Mark Byrne <31762852 [email protected]>
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.
Type of Changes
Description
Fix a false positive for
missing-param-docwhere a method which is decorated withtyping.overloadwas expected to have a docstring specifying its parameters.Closes #9739