search

vgteam / vg

tools for working with genome variation graphs
https://biostars.org/tag/vg/
Other
1.09k stars 193 forks source link

man pages #2460

Open ekg opened 4 years ago

ekg commented 4 years ago

Let's make a man page for vg, and one for each subcommand!

To do this, we need a template man page. I will populate that with a stock transformation of the command's help text. I'm going to assign these based on who has been hacking the most on the command line interface.

@mr-c, do you have any suggestions for guidelines to follow when making these documents?

mr-c commented 4 years ago

@ekg use https://github.com/seqan/seqan3/tree/master/include/seqan3/argument_parser which will generate the unix manual pages + CTD descriptions for free? :-)

http://docs.seqan.de/seqan/master/?p=ArgumentParser

ekg commented 4 years ago

If we don't use something like this, then we are going to have to fight to keep things in sync. Maybe it is needed. It's a lot of typing but really useful.

On Mon, Sep 16, 2019, 19:41 Michael R. Crusoe notifications@github.com wrote:

@ekg https://github.com/ekg use https://github.com/seqan/seqan3/tree/master/include/seqan3/argument_parser which will generate the unix manual pages + CTD descriptions for free? :-)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/vgteam/vg/issues/2460?email_source=notifications&email_token=AABDQEI7MCMTX6U6KZNPZADQJ7AMTA5CNFSM4IXFANS2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD6Z54YI#issuecomment-531881569, or mute the thread https://github.com/notifications/unsubscribe-auth/AABDQEKXRZ5MKA5DD444CODQJ7AMTANCNFSM4IXFANSQ .