Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Re-evaluate short flags and multi-word option names on CLI #46

Open
3 tasks
sarath-p opened this issue Oct 31, 2019 · 4 comments
Open
3 tasks

Re-evaluate short flags and multi-word option names on CLI #46

sarath-p opened this issue Oct 31, 2019 · 4 comments

Comments

@sarath-p
Copy link
Contributor

Look at short flags in https://microsoft.github.io/bedrock-cli/commands and

  • See if we have consistency amongst commands
  • If not, propose an updated short flag name references
  • Codify these short flag names in documentation

For example, some commands have a short flag -p for --project and others have no short flag.

An effort was started in the past but is out of date here.. Use https://microsoft.github.io/bedrock-cli/commands as the source of truth

A command option should have same the same short flag and multi-word name across all CLI commands to be consistent.

Does this require updates to documentation?:
YES!

@mtarng mtarng changed the title Make short flags and multi-word option names consistent across all spk commands [SPK] Make short flags and multi-word option names and descriptions consistent across all spk commands Dec 11, 2019
@andrebriggs
Copy link
Member

@mtarng @sarath-p do we have further thoughts on this? Thanks for coming up with the inventory of the current commands. Did we have a proposal on how we want SPK command to look?

@sarath-p
Copy link
Contributor Author

sarath-p commented Jan 9, 2020

@andrebriggs - I don't think so but we can come up with a design proposal in the next sprint.

@andrebriggs
Copy link
Member

@sarath-p sounds good. Looking forward to it

@andrebriggs andrebriggs changed the title [SPK] Make short flags and multi-word option names and descriptions consistent across all spk commands Make short flags and multi-word option names and descriptions consistent across all spk commands Feb 28, 2020
@andrebriggs
Copy link
Member

An effort was started here. Let's iterate on this effort

cc @mtarng @sarath-p

@andrebriggs andrebriggs changed the title Make short flags and multi-word option names and descriptions consistent across all spk commands Re-evaluate short flags and multi-word option names on CLI Apr 13, 2020
@andrebriggs andrebriggs transferred this issue from microsoft/bedrock May 12, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants