Add docstrings for cubids/cli.py #391
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
|
entry point cli arguments raise a deprecation error, but the corresponding arg parsers do not. Should we add mention of deprecation in the corresponding arg parsers? |
singlesp
commented
Jan 16, 2025
cubids/cli.py
Outdated
| _main(argv=None) | ||
| Set entrypoint for "cubids" CLI. | ||
|
|
||
| Each function that serves as an entry point for a CLI command in the formart of `cubids-function` |
There was a problem hiding this comment.
Check this wording + see related comment on the conversation page.
|
tsalo
requested changes
Jan 16, 2025
cubids/cli.py
Outdated
Comment on lines
310
to
320
| Returns | ||
| ------- | ||
| argparse.ArgumentParser | ||
| The argument parser with the necessary arguments configured. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| from_json : str | ||
| Source JSON file path. This file contains the data to be copied. | ||
| to_json : str | ||
| Destination JSON file path. This file will have data from `from_json` copied into it. |
There was a problem hiding this comment.
Can you put Parameters before Returns in these?
There was a problem hiding this comment.
It looks like it's still backwards in this one.
Co-authored-by: Taylor Salo <[email protected]>
tsalo
approved these changes
Jan 16, 2025
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.
relates to #384 and #358.
Changes proposed in this pull request