Join GitHub today
Add man page #1779
Since it's been over a month, I hope this isn't inappropriate to ask again. I'm partial to having manpages be a manual process since their purpose is for human consumption. Just as manual API documentation isn't ideal, hand-written manpages should be handwritten. It seems like the main contributors disagree, but I'd like to find a happy medium. Perhaps a git commit hook that monitors any changes to the inputs and outputs of specific functions, or changes to the
I'd like to make it clear that my intent is to make it easier for developers to learn about how to use the tool. I'm very much a fan of
Side note: thanks for the great tool!
I generally agree that documentation should be handwritten - that's why i hand-write
However, I never use manpages myself (because so few tools have actually useful manpages on the CLI in my experience; googling is much easier), so I'm unlikely to maintain the manpages - and since I'm the sole maintainer, that means that they'll likely go out of date a lot.
If you don't think it's possible to have a manpage autogenerated from