Add help text for codegen and datasets CLI #639
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
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #639 +/- ##
==========================================
+ Coverage 97.19% 97.24% +0.05%
==========================================
Files 29 29
Lines 1958 1994 +36
==========================================
+ Hits 1903 1939 +36
Misses 55 55
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
gordonwatts
added
documentation
There was a problem hiding this comment.
Pull Request Overview
This PR adds help text and documentation improvements to the ServiceX CLI's codegen and datasets command groups. The changes focus on making the CLI more discoverable and user-friendly by adding descriptive help text for command groups and individual commands.
- Added callback functions with help text for both codegen and datasets command groups
- Enhanced docstrings for existing commands to be more descriptive and informative
- Added a minor assertion to ensure type safety in the datasets list command
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| servicex/app/datasets.py | Added help text for datasets command group and improved docstrings for list, get, and delete commands |
| servicex/app/codegen.py | Added help text for codegen command group with callback function |
Co-authored-by: Copilot <[email protected]>
…ub.com/ssl-hep/ServiceX_frontend into codex/add-help-strings-for-subcommands
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.
Summary
Also discovered some commands I didn't know about - very cool! Help text to, I hope, aid discovery for others!
https://chatgpt.com/codex/tasks/task_e_689279e97aac83208bfd64635effa9d5