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

Docs docs docs #83

Open
guillermo-carrasco opened this issue Mar 23, 2015 · 1 comment
Open

Docs docs docs #83

guillermo-carrasco opened this issue Mar 23, 2015 · 1 comment
Labels

Comments

@guillermo-carrasco
Copy link

Hmmm this is just a question: Do you think it is enough with the help of the package?

(master) ~/repos_and_code/TACA (master) ~> taca --help
Usage: taca [OPTIONS] COMMAND [ARGS]...

  Tool for the Automation of Storage and Analyses

Options:
  --version                   Show the version and exit.
  -c, --config-file FILENAME  Path to TACA configuration file
  --help                      Show this message and exit.

Commands:
  analysis  Analysis methods entry point
  storage   Storage management methods and utilities

etc. Or do you think we should add a page per subcommand in the documentation? Like one page for taca storage, one page per taca analysis, etc.

I don't want to over-document, thats the thing, but I don't want either that subcommands or options become forgotten. On the other hand... is a subcommand becomes forgotten is basically because it is not used, so it shouldn't be there....

what do you think? @senthil10 @vezzi @ewels @mariogiov

@senthil10
Copy link
Member

@guillermo-carrasco : I like the concept of adding per page for a sub command, will be informative and clean :)

But I also feel such documentation will look more good/pretty when we have couple of sub commands other than analysis and storage (I think it will as TACA is growing). So each page can explain all about the sub commands and its parameters, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants