Tuesday, March 11, 2014

Docopt notes

I raved previously about docopt. Docopt can be finicky about how you write the docstring. Here are some tips:

No empty line between "Usage:" and the first usage pattern.

Usage:
      <---- Don't do this
mutate snp [-r <REF>] [-p <SNP>]

No empty lines between usage patterns

Usage:
mutate snp [-r <REF>] [-p <SNP>]
      <---- Don't do this

mutate cnv [-r <REF>] [-p <SNP>]

No comments:

Post a Comment