search

SamuelSchlesinger / commander-cli

A simple library I wrote to allow me to quickly and easily construct command line interfaces.
MIT License
29 stars 2 forks source link

Automated Documentation of CLI Programs #2

Open SamuelSchlesinger opened 4 years ago

SamuelSchlesinger commented 4 years ago

It would be great to have better automated documentation, though it is very low priority for me, as I don't find myself needing anything more than what I have now.

SamuelSchlesinger commented 4 years ago

https://github.com/SamuelSchlesinger/commander-cli/pull/4 was a step forward

SamuelSchlesinger commented 4 years ago

4 may have been worse for docs, actually, in the sense that it added a feature that I am unsure of the value of. Having the Haskell types is cool for a Haskeller, but it is totally useless otherwise.

SamuelSchlesinger commented 4 years ago

I think #4 was a lot better actually, though perhaps there will be some fun newtype games to play with big programs. More generally, the current implementation of things like arg sort of forbid me from representing the help text at the term level, and doing it at the type level comes with ergonomics costs of specifying the type of a command line interface in full.

BebeSparkelSparkel commented 3 years ago

Perhaps allowing a reader config on the printing format of the documentation could be helpful for allowing different formatting.

SamuelSchlesinger commented 3 years ago

That would be excellent. I would review pull requests for this.