cobra icon indicating copy to clipboard operation
cobra copied to clipboard

Fix documentation inconsistencies

Open kajes opened this issue 1 year ago • 1 comments

This fixes inconsistencies between the command help template and what is being generated as markdown.

Currently, the help template prints "Flags" and "Global Flags" when printing help for flags, while in the markdown, the two are printed as "Options" and "Options inherited from parent commands".

This Pull Request fixes this inconsistency, so that they both print the same. As for the actual formulation, I opted for using "Flags" and "Flags inherited from parent commands". In the latter case, I think this formulation actually represents it better than the previous "Global flags", since flags printed there are in fact inherited and not necessarily global in scope. This is, of course, up for discussion what to actually use.

Edit: Excuse the typo in the second commit message :grin:

kajes avatar Oct 11 '23 12:10 kajes

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Oct 11 '23 12:10 CLAassistant