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

Identify areas for improvement in tutorials and tests #166

Closed
3 tasks
damonbayer opened this issue Jun 7, 2024 · 1 comment · Fixed by #191
Closed
3 tasks

Identify areas for improvement in tutorials and tests #166

damonbayer opened this issue Jun 7, 2024 · 1 comment · Fixed by #191
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@damonbayer
Copy link
Collaborator

damonbayer commented Jun 7, 2024

Goal

Our tutorials and tests should have realistic examples with good explanations, so that it is easier to verify that code is working as expected.

Some examples:

  • when we work with a hospital admissions model, we shouldn't have examples that lead to 0 observed admissions.
  • All figures should have titles and axis labels
  • Are there any obvious tutorials missing? (Intro to renewal models)
@damonbayer damonbayer changed the title Revise Tutorials and Tests to be more realistic Identify areas for improvement in tutorials and tests Jun 10, 2024
@damonbayer damonbayer added this to the L Sprint milestone Jun 10, 2024
@damonbayer
Copy link
Collaborator Author

This should be a separate PR / code review from #83, but it can be used for inspiration.

@damonbayer damonbayer added the documentation Improvements or additions to documentation label Jun 10, 2024
@sbidari sbidari linked a pull request Jun 13, 2024 that will close this issue
@damonbayer damonbayer modified the milestones: 🐺 Lycorhinus, M Sprint Jun 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants