Open hdrake opened 4 years ago
Added docstrings to model.jl
functions and structures, trying to follow conventions in the julia docs.
Not sure this is worth doing until the source code is cleaned up a bit first and at least formally made into a (private for now) Julia package (see Issue https://github.com/hdrake/OptimizeClimate/issues/7).
At a bear minimum, I need to add some docstrings (no idea how to do this, especially in Julia). Ideally, we would eventually have extensive documentation at https://readthedocs.org/, complete with installation instructions and a tutorial.