This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
Preventing the D103 error when the function is decorated with @overload. #511
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
Added an is_overload method in the function class(parser.py). Added an if statement so that the D103 error will not trigger when decorated with @overload(checker.py) Added some tests to see that it's working correctly.
Added an is_overload method in the function class(parser.py). Added an if statement so that the D103 error will not trigger when decorated with @overload(checker.py) Added some tests to see that it's working correctly.
Added an if statement so that the D103 error will not trigger when decorated with @overload(checker.py) Added some tests to see that it's working correctly.
|
@theyuvalraz can you please rebase :)? |
…error # Conflicts: # src/pydocstyle/checker.py
|
@theyuvalraz we also introduced isort and black formatting to the source code. You will want to run after installing the pinned versions from the requirements file. |
Running isort src/pydocstyle
…n a docstring.
samj1912
reviewed
Sep 6, 2020
samj1912
reviewed
Sep 6, 2020
Functions decorated with @overload
samj1912
reviewed
Sep 6, 2020
samj1912
reviewed
Sep 6, 2020
samj1912
suggested changes
Sep 13, 2020
…nd overloaded Methods with D418 Error.
samj1912
reviewed
Sep 13, 2020
|
apart from the above lgtm |
|
Thanks everything looks good! Can you also update the release notes with this change? |
samj1912
previously approved these changes
Sep 13, 2020
samj1912
reviewed
Sep 13, 2020
samj1912
approved these changes
Sep 13, 2020
|
Thank you for this pull request! |
|
@samj1912 would it be possible to have a new release of |
|
Yeah, didn't notice this was not released. I will cut a release later today. |
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.
Fixes #419
Added an is_overload method in the function class(parser.py).
Added an if statement so that the D103 error will not trigger when decorated with @overload(checker.py)
Added some tests to see that it's working correctly.
The lambda method in the checker returns None, not sure its a good practice. any suggestions ?