Added missing docstrings for CLI script functions #805
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
Signed-off-by: Michael Zhou <myz227@nyu.edu> Inserted new docstrings for CLI functions without preexisting descriptions of their purpose, arguments, exceptions, return values, and special effects. Also modified old vague docstrings with more substantial function documentation.
|
Closing due to inactivity. Re-visit with #811. |
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.
Please fill in the fields below to submit a pull request. The more information
that is provided, the better.
Fixes issue #763:
Description of the changes being introduced by the pull request:
Inserted new docstrings for CLI functions without preexisting description docstrings with their specific purpose, arguments, exceptions (with conditions), return values, and special effects. Also modified old vague docstrings for some functions to provide more substantial function documentation.
Please verify and check that the pull request fulfills the following
requirements: