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

Improve output if invalid number of command line arguments are provided #458

Closed
qweeah opened this issue Jul 25, 2022 · 1 comment · Fixed by #1201
Closed

Improve output if invalid number of command line arguments are provided #458

qweeah opened this issue Jul 25, 2022 · 1 comment · Fixed by #1201
Labels
ux User experience related
Milestone

Comments

@qweeah
Copy link
Contributor

qweeah commented Jul 25, 2022

For all ORAS commands (login, logout, pull, push, attach, discover, copy), if the number of input argument doesn't match expected, user will get errors like:

Error: accepts X arg(s), received Y

It could confuse users who are not familiar with cobra concepts. E.g. they might think number of flags doesn't meet what is expected.

We need to provide more clear details for the error, including:

  1. what is expected
  2. what is got from input
@shizhMSFT shizhMSFT added this to the v0.14.0 milestone Jul 26, 2022
@shizhMSFT
Copy link
Contributor

It could confuse users who are not familiar with cobra concepts. E.g. they might think number of flags doesn't meet what is expected.

In that case, users should run the help command for usages.

@qweeah qweeah modified the milestones: v0.14.0, v1.2.0 Dec 7, 2023
@qweeah qweeah reopened this Dec 7, 2023
@qweeah qweeah added the ux User experience related label Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ux User experience related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants