Improved docstrings and some type hints. #134
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
Contributor
TimothyCera-NOAA
commented
Feb 7, 2024
TimothyCera-NOAA
commented
- Removed markdown markup in docstrings in favor of using "--docformat numpy" for the pdoc command in create_docs.sh.
- Used numpy format for the "Return" sections to be properly rendered by "pdoc --docformat numpy ...".
- Removed blank lines between parameters in the "Parameters" section.
- Added missing docstrings.
- Minor improvements to type hints:
- np.array to NDArray,
- Optional[] wherever argument could be None,
- Addition of Union where needed.
* Removed markdown markup in docstrings in favor of using "--docformat numpy" for the pdoc command in create_docs.sh. * Used numpy format for the "Return" sections to be properly rendered by "pdoc --docformat numpy ...". * Removed blank lines between parameters in the "Parameters" section. * Added missing docstrings. * Minor improvements to type hints: + np.array to NDArray, + Optional[] wherever argument could be None, + Addition of Union where needed.
Missed these changes when rebasing.
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.