Add pre-commit checks and various other cleanup & fixes#112
Merged
Conversation
- Add pre-commit configuration and dependency. - Add newlines to end of files. - Remove unnecessary whitespace. - Make author information current in docstrings. - Update all docstrings to be pep257-compliant, where possible. - Add noqa directives where necessary. - Improve type type information in docstrings. - Use double backticks consistently in docstrings. - Fix typos in README. - Add plugin configuration files.
- Use appropriate replacements from `numpy` and `nose.`
- Add maintainer name and email. - Update Jeremy's email. - Add Python 3.10 as supported version. - Update description.
- Update version in `conf.py`. - Fix typos. - Create links for modules, classes, and methods. - Update requirements. - Specify language.
Codecov ReportBase: 94.32% // Head: 94.22% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #112 +/- ##
==========================================
- Coverage 94.32% 94.22% -0.10%
==========================================
Files 7 7
Lines 1004 1004
==========================================
- Hits 947 946 -1
- Misses 57 58 +1
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Collaborator
Author
|
I think the change in coverage is acceptable given that the number of lines went up because of applying black and expanding the docstrings. I didn't really change any code. |
jbiggsets
reviewed
Sep 6, 2022
jbiggsets
approved these changes
Sep 7, 2022
jbiggsets
left a comment
Collaborator
There was a problem hiding this comment.
This looks good to me!
This file contains hidden or 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
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 closes #110.
Apply pre-commit checks to all files.
Replace deprecated
pandas.util.testing.numpyandnose.Update
setup.pyFix various issues in documentation.
conf.py.