PEP 8 compliance, type hints, and Google-style docstrings#13
Draft
aalexmmaldonado wants to merge 13 commits intomainfrom
Draft
PEP 8 compliance, type hints, and Google-style docstrings#13aalexmmaldonado wants to merge 13 commits intomainfrom
aalexmmaldonado wants to merge 13 commits intomainfrom
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #13 +/- ##
==========================================
+ Coverage 56.41% 57.22% +0.81%
==========================================
Files 25 25
Lines 1980 1924 -56
Branches 381 385 +4
==========================================
- Hits 1117 1101 -16
+ Misses 716 669 -47
- Partials 147 154 +7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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 starts to rework the module names, classes, and imports to be PEP 8 compliant. This includes
snake_casefor modules and functions andCamelCasefor classes. Type hints are being added to improve developer experience, but RDKit appears to not have reliable stubs besides this package that does not seem to be well maintained. Docstrings should also be in the Google style.