Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a help subcommand to all CLI groups #221

Merged
merged 1 commit into from
Aug 21, 2020
Merged

Add a help subcommand to all CLI groups #221

merged 1 commit into from
Aug 21, 2020

Conversation

craigds
Copy link
Member

@craigds craigds commented Aug 21, 2020

Description

This adds a help command to all CLI groups including sno itself.

Synonym examples:
sno help == sno --help
sno help commit == sno commit --help sno data help==sno data --help sno data help ls==sno data ls --help`

This can't be automatically valid for all commands because it could make
the meaning ambiguous. However, it can be valid for all groups, which
is probably 99% of the cases it's useful.

For instance, sno diff help doesn't make sense because help could be
the name of a dataset and thus there's an ambiguity here

Related links:

Fixes #127

Checklist:

  • Have you reviewed your own change?
  • Have you included test(s)?
  • Have you updated the changelog?

@craigds craigds mentioned this pull request Aug 21, 2020
@craigds craigds requested a review from olsen232 August 21, 2020 00:35
@craigds craigds force-pushed the help-command branch 2 times, most recently from 69e8cf0 to 48e901f Compare August 21, 2020 00:39
Synonym examples:
`sno help` == `sno --help`
`sno help commit` == sno commit --help`
`sno data help` == `sno data --help`
`sno data help ls` == `sno data ls --help`

This can't be automatically valid for all commands because it could make
the meaning ambiguous. However, it can be valid for all *groups*, which
is probably 99% of the cases it's useful.

For instance, `sno diff help` doesn't make sense because `help` could be
the name of a dataset and thus there's an ambiguity here

Fixes #127
@craigds craigds merged commit 19f8e7d into master Aug 21, 2020
@craigds craigds deleted the help-command branch August 21, 2020 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a help subcommand
2 participants