[Feature Request] confusing command line arguments / flags

[Brilator]

User feedback from yesterday's hands-on workshop: duplicated use of same letters for arguments and flags is confusing

• arc i create -i ...
• arc s add -s ...
• arc a add -a ...

No good idea for improvement without breaking changes. But it might be better to change to less short abbreviations (inv instead of i) and / or use -i consistently for any kind of identifier (no matter wether i, s or a is being created)

[omaus]

Maybe replacing with -id (which it actually is)? @HLWeil

[Brilator]

No, they're not. And it actually makes sense... E.g. when adding study and assay in one go: arc a add -s ... -a ....

I'll go ahead and avoid using the abbreviations and instead use the more concise --identifier, --studyidentifier, --assayidentifier in examples.

[HLWeil]

Or maybe deabbreviate the command?

e.g. arc assay add -s ... -a ...

[omaus]

What about an a bit more verbose flag like -sid (for --studyidentifier) and so on?

[Brilator]

Ok, both fine (to abbreviate one or the other), but there's still an inconsistency between the levels:

arc investigation create --identifier
arc study add --identifier
arc assay add --studyidentifier --assayidentifier

At least the studyidentifier should always be called like this. Preferably, the investigationidentifier would also be more precise.

[HLWeil]

I would not use half-shortened argument names like -sid. Increasing consistency in the full names would be a good approach though:

arc investigation create --investigationidentifier
arc study add --studyidentifier
arc assay add --studyidentifier --assayidentifier`