broadinstitute / gdctools

Python and UNIX CLI utilities to simplify interaction with the NIH/NCI Genomics Data Commons
Other
31 stars 4 forks source link

docs need to be explicit about how configuration works: cli flags, config files, defaults ... #50

Closed noblem closed 6 years ago

noblem commented 7 years ago

... etc. Most of WHAT needs to be said is given in the code comments of GDCtool::config_finalize() method, so this is a placeholder to finish bubbling that up to public docs/Wiki page.

noblem commented 6 years ago

The https://github.com/broadinstitute/gdctools/wiki/Configuration-by-example page has been improved towards this end. Like all documentation, it could be even better, but for now it's sufficient to warrant closing this.