Changed rules to use docstring as shortdesc #1994
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
Simplifies rule by ensuring that we do use the docstring as their short description. This also enables us to address most pylint no-class-docstring excludes.
ssbarnea
requested review from
relrod,
ganeshrn,
priyamsahoo,
cidrblock and
a team
and removed request for
a team,
relrod,
ganeshrn and
priyamsahoo
cidrblock
approved these changes
Mar 14, 2022
This was referenced Mar 14, 2022
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.
Simplifies rule by ensuring that we do use the docstring as their short description. This also enables us to address most pylint no-class-docstring excludes.
That is an alternative to another linked PR I made yesterday where I tried to put the description in a docstring, but that proved to cause several problems related to formatting
of docstrings with rst. This approach is simple and without undesired effects.
Related: #1993