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

Bug: Autogenerated CLI documentation is missing option descriptions #3312

Open
renanrodrigo opened this issue Sep 17, 2024 · 0 comments
Open
Labels
bug something isn't working docs P - Low S - Triaged Must have priority label

Comments

@renanrodrigo
Copy link
Member

Description of the bug

After the autogeneration of content for the CLI is in, the manpage and rst generated documentation mention the flags and options used for each command only in the usage line.

We need to add a description of what each of those do, just like the help text from argparse presents them.
We need to format it properly and decide on what to show or not in the manpage and in the docs, depending on formatting options and content expectations.

Expected behavior

When you check the manpage or the rst docs, you see a list of commands and a list of flags/options for each command with explanations and descriptions.

Current behavior

Flags are shown only in the usage line, and there is no explanation about them unless you run --help on the CLI.

To Reproduce

Check autogenerated docs.

System information:

  • Ubuntu release: Xenial to Oracular
  • Pro Client version: 35

Additional context
This bug is somewhat blocked on #3311. We could just add the information there, but unformatted it will look horrible.

@renanrodrigo renanrodrigo added bug something isn't working docs labels Sep 17, 2024
@orndorffgrant orndorffgrant added S - Triaged Must have priority label P - Low labels Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug something isn't working docs P - Low S - Triaged Must have priority label
Projects
None yet
Development

No branches or pull requests

2 participants