cli icon indicating copy to clipboard operation
cli copied to clipboard

Inconsistent parameters vs flags for axiom dataset create

Open max opened this issue 3 years ago • 1 comments

  • 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.

max avatar Aug 11 '22 21:08 max

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.

lukasmalkmus avatar Aug 12 '22 10:08 lukasmalkmus