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

Document standard CLI help format #224

Closed
4 tasks
SteveLasker opened this issue Jul 6, 2022 · 4 comments
Closed
4 tasks

Document standard CLI help format #224

SteveLasker opened this issue Jul 6, 2022 · 4 comments
Assignees
Labels
UX User experience changes

Comments

@SteveLasker
Copy link
Contributor

The CLI has a few options for how to represent help contents.
This issue tracks a proposal for that format to include:

  • Include format for positional arguments
  • Include format for global arguments
  • Include format for examples
  • Formatting, including the command and whether : is specified.

See #223 for an example for why a formatting template is needed across multiple PRs

@SteveLasker SteveLasker added this to the RC-1 milestone Jul 6, 2022
@SteveLasker SteveLasker self-assigned this Jul 6, 2022
@yizha1 yizha1 added the UX User experience changes label Aug 11, 2022
@FeynmanZhou
Copy link
Member

Hi @SteveLasker @yizha1 @shizhMSFT @iamsamirzon

I can start to work on this issue to add more examples to the CLI help doc in these source files and format for arguments.

@FeynmanZhou
Copy link
Member

FeynmanZhou commented Nov 1, 2022

@SteveLasker Can you elaborate more on this issue? Do you want a CLI help doc template for each CLI command help information?

BTW, we are adding some examples to the CLI help doc to make it user-friendly, see this PR as an example.

@FeynmanZhou FeynmanZhou modified the milestones: RC-1, Discuss Dec 2, 2022
@yizha1
Copy link
Contributor

yizha1 commented Aug 4, 2023

@SteveLasker we have CLI specs and help doc for each notation commands. Can we close this issue?

@yizha1
Copy link
Contributor

yizha1 commented Apr 9, 2024

Closed as we have CLI specs and CLI help in the output of commands.

@yizha1 yizha1 closed this as completed Apr 9, 2024
@yizha1 yizha1 removed this from the Discuss milestone Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
UX User experience changes
Projects
Status: Done
Development

No branches or pull requests

3 participants