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

Cobra's built-in Man Doc generation #3

Open
meyermarcel opened this issue Jan 13, 2022 · 1 comment
Open

Cobra's built-in Man Doc generation #3

meyermarcel opened this issue Jan 13, 2022 · 1 comment

Comments

@meyermarcel
Copy link

What is the advantage of this package compared to Cobra's built-in well tested Man Doc generation?

See https://github.com/spf13/cobra/blob/2a5277810f24ae1b8a200198be8dd855a9041a0e/doc/man_docs.go

@muesli
Copy link
Owner

muesli commented Jan 14, 2022

Cobra generates a series of man pages, one for each sub-command. While that is fine for big command-sets (think git), for the average cli tool this is absolute overkill, the opposite of user-friendly, and gets a big fat "nope" from package maintainers. I actually tried to improve this situation in Cobra first, but their man-page generation is a bit awkward: it generates markdown, which then gets converted to the roff format. This is another thing I wanted to avoid, because it doesn't exactly lead to beautiful man pages (if there's such a thing, heh).

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

2 participants