search

csdms / babelizer

Transform BMI-wrapped models into Python packages
https://babelizer.readthedocs.io
MIT License
4 stars 3 forks source link

Complete API documentation #55

Closed mdpiper closed 3 years ago

mdpiper commented 3 years ago

We build API documentation for the babelizer, but some of the babelizer modules were missing docstrings. This PR updates all the babelizer modules with descriptive docstrings. Also included sphinx-click as a dependency to build docs for a click-based application.

This fixes #52.

lheagy commented 3 years ago

This looks good! I think this is sufficient for the JOSS review. One suggestion that is based on my preferences: it might be nice to consider breaking up this single page into multiple, with each module having its own page. There is a lot of information here, so that might help make it a bit more digestible. But up to you all on how you would like to present the info

mdpiper commented 3 years ago

Thanks, @lheagy! I took your suggestion to break up the API docs into one module / page (and by doing so, I think it helped me catch some errors). I'll merge this PR and close the referring issue.