Convert documentation to Google-style strings and give it a full look over#21
Open
gcassella wants to merge 2 commits into
Open
Convert documentation to Google-style strings and give it a full look over#21gcassella wants to merge 2 commits into
gcassella wants to merge 2 commits into
Conversation
Codecov Report
@@ Coverage Diff @@
## main #21 +/- ##
=======================================
Coverage 76.28% 76.28%
=======================================
Files 15 15
Lines 1324 1324
=======================================
Hits 1010 1010
Misses 314 314
Continue to review full report at Codecov.
|
Contributor
Author
|
I might also take this opportunity to snipe any linting errors and add pylint to our CI pipeline |
06e5ad4 to
22d4c00
Compare
Contributor
Author
|
for future reference, these changes can be summarized by the commands: |
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.
I've used
docconvert(https://github.com/cbillingham/docconvert) to autoconvert our docstrings from reStructuredText to Google style docstrings. There are a few other things we should do before merging the PR:If we want to go full Google, here is our bible: https://google.github.io/styleguide/pyguide.html