search

pacificclimate / modelmeta

An ORM representation of the model metadata database
GNU General Public License v3.0
1 stars 0 forks source link

Document indexing process #81

Open corviday opened 5 years ago

corviday commented 5 years ago

The indexing/associating process is straightforward, but there's no documentation for it aside from -h on the relevant commands and there is some nice functionality that can save time and effort if one knows about it. A README in /scripts would be useful.

jameshiebert commented 5 years ago

Great idea! Even better than a README, however, would be to add detailed documentation to the -h command line flag. The most convenient way for us to be able to use this software is to just pip install it and run it (without having to clone the repo and dig through even an README). So making the documentation accessible from the tool would be ideal. (We could always do both of course... write it in a README, and have the tool use that file as a resource file to print it out upon -h invocation).