search

epiverse-trace / epichains

[Under active development] Methods for simulating and analysing the sizes and lengths of infectious disease transmission chains from branching process models
https://epiverse-trace.github.io/epichains/
Other
5 stars 2 forks source link

Improve documentation of `nsim_obs` and `obs_prob` #233

Closed jamesmbaazam closed 5 months ago

jamesmbaazam commented 5 months ago

This PR closes #231 by improving the documentation of nsim_obs and obs_prob so that it is clear that they are linked. The improvement also adds some interpretation to the arguments.

codecov-commenter commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.80%. Comparing base (5d75c59) to head (b8381a2). Report is 3 commits behind head on main.

:exclamation: Current head b8381a2 differs from pull request most recent head c54e96c. Consider uploading reports for the commit c54e96c to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #233 +/- ## ======================================= Coverage 98.80% 98.80% ======================================= Files 8 8 Lines 584 584 ======================================= Hits 577 577 Misses 7 7 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.