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

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

Open
IanMadd opened this issue Jun 23, 2024 · 0 comments

Comments

@IanMadd
Copy link

IanMadd commented Jun 23, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant