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

Better docstrings for probs and counts #382

Merged
merged 6 commits into from
Jan 14, 2024

Conversation

kahaaga
Copy link
Member

@kahaaga kahaaga commented Jan 14, 2024

Fixes the remainder of #370.

  • There was no mention of Counts at all in the Probabilities doctoring, so the probs_or_counts argument in the docstring wasn't really making much sense. Therefore, I split the constructor signature up into two lines, and explicitly reference Counts.
  • Clarified that when inputting Counts without specifying outcomes, then the outcomes are inherited from Counts.
  • Slight rewording and a few extra words to make it explicit what "probabilities correspond to outcomes that describe axes" mean.
  • Added a few short examples of constructing a Probabilities (show, don't tell). This point can be omitted, but I find it useful.

@kahaaga kahaaga added the documentation Improvements or additions to documentation label Jan 14, 2024
Copy link

codecov bot commented Jan 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (80202b9) 88.68% compared to head (62da385) 88.68%.

❗ Current head 62da385 differs from pull request most recent head 3b445a4. Consider uploading reports for the commit 3b445a4 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #382   +/-   ##
=======================================
  Coverage   88.68%   88.68%           
=======================================
  Files          80       80           
  Lines        2359     2359           
=======================================
  Hits         2092     2092           
  Misses        267      267           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/core/probabilities.jl Outdated Show resolved Hide resolved
Co-authored-by: George Datseris <[email protected]>
@kahaaga kahaaga merged commit dc0237b into main Jan 14, 2024
2 checks passed
@kahaaga kahaaga deleted the better_docstrings_for_probs_and_counts branch January 14, 2024 12:53
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 this pull request may close these issues.

2 participants