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

Automated Documentation of CLI Programs #2

Open
SamuelSchlesinger opened this issue Jun 10, 2020 · 5 comments
Open

Automated Documentation of CLI Programs #2

SamuelSchlesinger opened this issue Jun 10, 2020 · 5 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@SamuelSchlesinger
Copy link
Owner

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 SamuelSchlesinger added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jun 10, 2020
@SamuelSchlesinger
Copy link
Owner Author

#4 was a step forward

@SamuelSchlesinger
Copy link
Owner Author

#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
Copy link
Owner Author

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
Copy link
Contributor

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

@SamuelSchlesinger
Copy link
Owner Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants