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.
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
--helpon the CLI.To Reproduce
Check autogenerated docs.
System information:
Additional context This bug is somewhat blocked on #3311. We could just add the information there, but unformatted it will look horrible.