Add some more docstrings. #536
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
| @@ -25,10 +25,12 @@ | |||
|
|
|||
|
|
|||
| class InvalidGridShapeError(Exception): | |||
There was a problem hiding this comment.
Side question: should these Error classes should be in error.py?
There was a problem hiding this comment.
That would make sense to me. I didn't try and move them in this PR though.
|
I'm fine with removing the unused Error classes... I seem to remember that Kurt was in favor of this too. @kwmsmith ? |
|
I have removed the unused exception classes. The tests still pass locally. |
|
Looks good to me, and builds without errors. |
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.
This PR adds some more docstrings to distarray, to get better coverage as per issue #525.
It also makes some pep8 adjustments, where I felt like following its rules. A lot of the added docstrings are for exception classes, and as I was investigating these, several seemed to be unused. In those cases, instead of adding a docstring (since there was no usage to suggest the correct text), I added a comment that the exception class seemed to be unused. If they really are unused, then perhaps they should just be removed from the code base. But I did not do that here so far.