Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write more thorough documentation for the ModelInfo class #431

Open
emprzy opened this issue Dec 18, 2024 · 0 comments
Open

Write more thorough documentation for the ModelInfo class #431

emprzy opened this issue Dec 18, 2024 · 0 comments
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.

Comments

@emprzy
Copy link
Collaborator

emprzy commented Dec 18, 2024

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 in model_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 in model_info.py generally consistent with these conventions.

@emprzy emprzy added documentation Relating to ReadMEs / gitbook / vignettes / etc. good first issue Good for newcomers. gempyor Concerns the Python core. docstring Relating to in-code documentation. labels Dec 18, 2024
@TimothyWillard TimothyWillard added the low priority Low priority. label Jan 7, 2025
@TimothyWillard TimothyWillard added this to the Software Quality milestone Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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.
Projects
None yet
Development

No branches or pull requests

2 participants