Improve documentation of nsim_obs and obs_prob
#233
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jamesmbaazam
force-pushed
the
improve-likelihood-arg-docs
branch
from
ff5492b to
c54e96c
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #233 +/- ##
=======================================
Coverage 98.80% 98.80%
=======================================
Files 8 8
Lines 584 584
=======================================
Hits 577 577
Misses 7 7 ☔ View full report in Codecov by Sentry. |
jamesmbaazam
force-pushed
the
improve-likelihood-arg-docs
branch
from
c54e96c to
b9559a9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR closes #231 by improving the documentation of
nsim_obsandobs_probso that it is clear that they are linked. The improvement also adds some interpretation to the arguments.