This repository has been archived by the owner on Nov 3, 2023. It is now read-only.
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.
Problem
pep257 complains that setters (and mabye deleters) have no docstring.
Here is an example
Documentation tools should ignore setters and deletes docstring when creating api docs.
Also, setters and deleters are pretty standard and they will only have a boilerplate text which will not say anything new.
Changes
Updated the parser to keep a record for decorators.
In Method.is_private i check the list of decorators and if decorators start with same name then it is marked private.
I have removed unused / broken tests from test_pep257 as this is just hoarding of junk. http://blog.8thlight.com/uncle-bob/2014/04/03/Code-Hoarders.html
Added test for new code.
How to test
Check that changed make sense
py.test test_pep257.py -v
Let me know if you find this useful.
Thanks!