Code documentation cleanup #631
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
vtnate
approved these changes
Apr 12, 2024
There was a problem hiding this comment.
Standardization ftw! Do we want to go farther in improving docstrings at this time? If we wanna get crazy and do code examples in docstrings, at least ruff knows how to handle that.
| """ | ||
| Create system parameters file using uo_sdk output | ||
| """Create system parameters file using uo_sdk output | ||
| #FIXME: Formatting of the args... |
There was a problem hiding this comment.
What needs to be formatted in the cli args?
There was a problem hiding this comment.
The args in the doctoring need to be formatted differently...
hit cmd-shift-2 after the function and it should stub it out for you (in VScode)
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.
Any background context you want to provide?
Just making the docstrings consistent.