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

Document the functionality of the tool properly #79

Open
ionut-arm opened this issue Apr 1, 2022 · 0 comments
Open

Document the functionality of the tool properly #79

ionut-arm opened this issue Apr 1, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation medium Effort label

Comments

@ionut-arm
Copy link
Member

The functionality of the Parsec tool (commands, options...) is available as part of the binary itself, generated by clap, but no proper external documentation exists. This page documents the process of rendering such documentation as a manpage for a Rust CLI app. The linked discussion points to clap-mangen as the tool to use for this purpose.

Another important factor would be to provide some example scripts for how to achieve various goals, in a markdown page.

Once such documentation is available, the Parsec book (in particular this page) should be enhanced with information about the manpage and the examples.

@ionut-arm ionut-arm added documentation Improvements or additions to documentation medium Effort label labels Apr 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation medium Effort label
Projects
None yet
Development

No branches or pull requests

1 participant