Write more thorough documentation for the ModelInfo
class
#431
Labels
docstring
Relating to in-code documentation.
documentation
Relating to ReadMEs / gitbook / vignettes / etc.
gempyor
Concerns the Python core.
good first issue
Good for newcomers.
low priority
Low priority.
Milestone
Label
documentation, docstring, good first issue
Priority Label
medium priority
Is your feature request related to a problem? Please describe.
There is a "TO DO" comment in the
ModelInfo
class definition (found inmodel_info.py
) calling for better documentation.ModelInfo
object instantiation is an important piece of a flepiMoP run, so it's optimal for us to thoroughly outline its attributes.Is your feature request related to a new application, scenario round, pathogen? Please describe.
N/A
Describe the solution you'd like
Write docstring documentation for
ModelInfo
class defined inmodel_info.py
generally consistent with these conventions.The text was updated successfully, but these errors were encountered: