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

Inconsistent parameters vs flags for axiom dataset create #136

Open
max opened this issue Aug 11, 2022 · 1 comment
Open

Inconsistent parameters vs flags for axiom dataset create #136

max opened this issue Aug 11, 2022 · 1 comment
Assignees
Labels
help wanted Extra attention is needed

Comments

@max
Copy link

max commented Aug 11, 2022

  • axiom dataset create expects the name for the dataset to create as a flag (--name).
  • axiom dataset delete expects the name for the dataset to delete as a parameter.

Without prior knowledge of the axiom dataset create command I assumed it would take the dataset name as a parameter just like the other dataset commands.

@lukasmalkmus lukasmalkmus self-assigned this Aug 12, 2022
@lukasmalkmus lukasmalkmus added the help wanted Extra attention is needed label Aug 12, 2022
@lukasmalkmus
Copy link
Collaborator

Thanks for the report!

The initial design choice was:

  • Command needs only one user input to run -> use a parameter/argument
  • Command needs more than one user input to run -> use flags

Additionally, you will be prompted for input when running interactively. This has the downside that axiom dataset create -n=test will result in a prompt asking for the description when no -d/--description flag was provided.

Unfortunately this has caused some minor confusion in the past.

Do you mind leaving your personal opinion down below? We're still in the process of evaluation some options (multi-param support?), this might be a good place to collect some first user input on this matter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants