Skip to content
New issue

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

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

Already on GitHub? # to your account

Docstrings are out of date #36

Open
14 tasks
tomjemmett opened this issue Feb 23, 2023 · 0 comments
Open
14 tasks

Docstrings are out of date #36

tomjemmett opened this issue Feb 23, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation must technical debt Technical Debt

Comments

@tomjemmett
Copy link
Member

I've not kept all of the docstrings up to date, and as such some functions now have out of date, or completely incorrect, docstrings. Every method needs to be checked

Files that have changed recently and need reviewing

  • run_model.py
  • model/activity_avoidance.py
  • model/model_run.py
  • model/model_save.py
  • model.py

Files that are very similar and probably (can) share docstrings

  • model/aae.py
  • model/inpatients.py
  • model/outpatients.py

Files that haven't changed recently and are probably ok

  • model/helpers.py
  • model/hsa_gams.py

Notebooks

Notebooks probably also need reviewing to ensure they are still correct

  • notebooks/check_gams.ipynb
  • notebooks/model_usage_example.ipynb
  • notebooks/run_model.ipynb
  • notebooks/use_results.rmd

The saved model results sample in this folder will need updating.

@tomjemmett tomjemmett self-assigned this Jul 24, 2023
@tomjemmett tomjemmett added the documentation Improvements or additions to documentation label Jul 24, 2023
@ChrisBeeley ChrisBeeley assigned yiwen-h and unassigned tomjemmett Oct 23, 2023
@ChrisBeeley ChrisBeeley added this to the Final QA'd model milestone Oct 31, 2023
@yiwen-h yiwen-h added the technical debt Technical Debt label May 24, 2024
@yiwen-h yiwen-h added the must label May 24, 2024
@tomjemmett tomjemmett removed this from the Final QA'd model milestone Nov 26, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation must technical debt Technical Debt
Projects
None yet
Development

No branches or pull requests

3 participants