DOC: Minor updates to docstrings #125
Merged
Conversation
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
* Fixes incorrect usage of `(optional)` instead of `, optional` for optional parameters in function/method docstrings * Updates docstrings with `key` parameter to correctly list them as an `optional` parameter * Updates function, method, and class references to use their correct tag (i.e. `:func:` for functions, `:class:` for classes) instead of using `:meth:`
|
Alright, I looked through the diff several times and checked many of the function/class references in the sphinx build. Everything looks good. |
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.
Description
Fixes incorrect usage of
(optional)instead of, optionalfor optional parameters in function/method docstringsUpdates docstrings with
keyparameter to correctly list them as anoptionalparameterUpdates function, method, and class references to use their correct tag (i.e.
:func:for functions,:class:for classes) instead of using:meth:Status