fix docstrings #217
Merged
fix docstrings #217
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
This was referenced Mar 5, 2024
Merged
Merged
Merged
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @CunliangGeng and the rest of your teammates on |
This was referenced Mar 5, 2024
Merged
gcroci2
approved these changes
Mar 5, 2024
CunliangGeng
force-pushed
the
fix_docstrings
branch
from
b6b3019 to
accf6dd
Compare
Merge activity
|
As static typing is used, it's not necessary to indicate types in the docstrings (see https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)
CunliangGeng
force-pushed
the
fix_docstrings
branch
from
accf6dd to
302dd9b
Compare
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 is to fix docstrings to ensure docstrings are formatted correctly to be used for building API documentations.
Major changes
ArgsandReturns(As static typing is used, it's not necessary to indicate types in the docstrings (see https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html)