Properties don't need @return annotations #46
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
|
I tried to to fix this. I have also added an exceptions for setter properties as I don't think that they need to document their value... and I would say that setter don't need a docstring as the getter should already document it. Please take a look and let me know if code is ok. Thanks! |
|
Looks pretty good. Thanks for a nice, small pull request :). |
glyph
added a commit
that referenced
this pull request
Mar 24, 2015
Properties don't need @return annotations
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.
The docstring for a property should basically be what would go in the
@returnannotation for a normal method, I don't think there is any reason to produce a warning in this case.Imported from Launchpad using lp2gh.