cobra icon indicating copy to clipboard operation
cobra copied to clipboard

The YAML docs gen description and synopsis fields are assigned to the wrong key

Open IanMadd opened this issue 7 months ago • 0 comments

In the YAML docs gen the cmd.Long maps to the description and cmd. Short maps to the synopsis.

In the other outputs, it's the reverse. For example, the MD docs gen, the cmd.Short maps to the command description and the cmd.Long maps to the command synopsis.

I think the MD version is correct and short/long fields should be swapped in the YAML generator.

IanMadd avatar Jun 23 '24 20:06 IanMadd