Review help/usage for cli commands #802
Open
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
The pattern followed is:
- Descriptions: Complete sentences with periods
- Help messages: Concise phrases without periods
- Consistent terminology ("Iterative Studio")
- Clear, standardized format for similar arguments
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #802 +/- ##
=======================================
Coverage 87.43% 87.43%
=======================================
Files 128 128
Lines 11332 11334 +2
Branches 1529 1529
=======================================
+ Hits 9908 9910 +2
Misses 1046 1046
Partials 378 378
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
0x2b3bfa0
reviewed
Jan 7, 2025
|
@amritghimire thanks! can you please put into description the end result (dump from CLI) please? |
Deploying datachain-documentation with
|
| Latest commit: |
c05200d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://55a85c36.datachain-documentation.pages.dev |
| Branch Preview URL: | https://amrit-fix-typos.datachain-documentation.pages.dev |
|
@amritghimire thanks, I've started the document - https://docs.google.com/document/d/1_QeMQ1NsguHSRSyJpF2n-1s57SHSuiyGzl10q9d1UaE/edit?tab=t.0 . Let's iterate there please. |
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.
The pattern followed is:
Final output:
usage: datachain studio [-h] [--aws-endpoint-url AWS_ENDPOINT_URL] [--anon] [-u] [-v] [-q] {login,logout,team,token,dataset} ... Manage authentication and settings for Studio. Configure tokens for sharing datasets and using Studio features. positional arguments: {login,logout,team,token,dataset} Use `datachain studio CMD --help` to display command-specific help login Authenticate with Studio logout Log out from Studio team Set default team for Studio operations token View Studio authentication token dataset List available Studio datasets options: -h, --help show this help message and exit --aws-endpoint-url AWS_ENDPOINT_URL AWS endpoint URL --anon AWS anon (aka awscli's --no-sign-request) -u, --update Update cache -v, --verbose Verbose -q, --quiet Be quietusage: datachain job [-h] [--aws-endpoint-url AWS_ENDPOINT_URL] [--anon] [-u] [-v] [-q] {run,cancel,logs} ... Commands to manage job execution in Studio. positional arguments: {run,cancel,logs} Use `datachain studio CMD --help` to display command-specific help run Run a job in Studio cancel Cancel a job in Studio logs Show job logs and status in Studio options: -h, --help show this help message and exit --aws-endpoint-url AWS_ENDPOINT_URL AWS endpoint URL --anon AWS anon (aka awscli's --no-sign-request) -u, --update Update cache -v, --verbose Verbose -q, --quiet Be quietusage: datachain dataset [-h] [--aws-endpoint-url AWS_ENDPOINT_URL] [--anon] [-u] [-v] [-q] {pull,edit,ls,rm,remove,stats} ... Commands for managing datasets. positional arguments: {pull,edit,ls,rm,remove,stats} Use `datachain dataset CMD --help` to display command-specific help options: -h, --help show this help message and exit --aws-endpoint-url AWS_ENDPOINT_URL AWS endpoint URL --anon AWS anon (aka awscli's --no-sign-request) -u, --update Update cache -v, --verbose Verbose -q, --quiet Be quietusage: datachain find [-h] [--aws-endpoint-url AWS_ENDPOINT_URL] [--anon] [-u] [-v] [-q] [--name NAME] [--iname INAME] [--path PATH] [--ipath IPATH] [--size SIZE] [--type TYPE] [-c COLUMNS] sources [sources ...] Search in a directory hierarchy. positional arguments: sources Data sources - paths to cloud storage dirs options: -h, --help show this help message and exit --aws-endpoint-url AWS_ENDPOINT_URL AWS endpoint URL --anon AWS anon (aka awscli's --no-sign-request) -u, --update Update cache -v, --verbose Verbose -q, --quiet Be quiet --name NAME Match filename pattern --iname INAME Match filename pattern (case insensitive) --path PATH Path to match pattern --ipath IPATH Like -path but case insensitive --size SIZE Filter by size (+ is greater or equal, - is less or equal). Specified size is in bytes, or use a suffix like K, M, G for kilobytes, megabytes, gigabytes, etc --type TYPE File type: "f" - regular, "d" - directory -c COLUMNS, --columns COLUMNS A comma-separated list of columns to print for each result. Options are: du,name,path,size,type (Default: path)datachain completion --help usage: datachain completion [-h] [--aws-endpoint-url AWS_ENDPOINT_URL] [--anon] [-u] [-v] [-q] [-s {bash,zsh,tcsh}] Output shell completion script. options: -h, --help show this help message and exit --aws-endpoint-url AWS_ENDPOINT_URL AWS endpoint URL --anon AWS anon (aka awscli's --no-sign-request) -u, --update Update cache -v, --verbose Verbose -q, --quiet Be quiet -s {bash,zsh,tcsh}, --shell {bash,zsh,tcsh} Shell syntax for completionsCloses #773