The Readme looks great - I just had a couple thoughts. The first is to not say the functions are self-explanatory... I'm actually pretty perplexed by the yaml_to_md(input_name, output_name, template_name) function... Are these filenames to pass in? Are they strings? What does the YAML look like? How do you access it? (I know the answer to these questions, but a naive reader wouldn't.) Speaking of, you should be documenting all your code according to the numpy standards. see here for an excellent example.. And the resulting auto-generated docs from that code are here
The Readme looks great - I just had a couple thoughts. The first is to not say the functions are self-explanatory... I'm actually pretty perplexed by the
yaml_to_md(input_name, output_name, template_name)function... Are these filenames to pass in? Are they strings? What does the YAML look like? How do you access it? (I know the answer to these questions, but a naive reader wouldn't.) Speaking of, you should be documenting all your code according to the numpy standards. see here for an excellent example.. And the resulting auto-generated docs from that code are here