You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We should have some better documentation in this repository on:
How to set up configuration files (and options)
High level functions (and models)
How to add/extend to the repository
I think (1) and (3) are known by some, but not well documented. Maybe best to do this in README.md
(2) really needs to be done (when the code is first written) in a docstring.
Minimally, the docstrings should include:
A brief description of what the function does
A description of the inputs
A description of the outputs
any assumptions the function makes (optional)
Better yet, we should have a standardized template for this.
Yes, this should be done for the models and important functions. No, this shouldn't be required of short helper functions (but it's always nice).
The text was updated successfully, but these errors were encountered:
We should have some better documentation in this repository on:
I think (1) and (3) are known by some, but not well documented. Maybe best to do this in README.md
(2) really needs to be done (when the code is first written) in a docstring.
Minimally, the docstrings should include:
Better yet, we should have a standardized template for this.
Yes, this should be done for the models and important functions. No, this shouldn't be required of short helper functions (but it's always nice).
The text was updated successfully, but these errors were encountered: