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

Some clarification of what functions do #266

Merged
merged 3 commits into from
Oct 30, 2023
Merged

Some clarification of what functions do #266

merged 3 commits into from
Oct 30, 2023

Conversation

Tobychev
Copy link
Contributor

@Tobychev Tobychev commented Oct 5, 2023

After struggling to understand what these functions do, I reworked the doc strings to be a bit more clear, added missing return value annotations.

@codecov
Copy link

codecov bot commented Oct 5, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4b617cc) 95.34% compared to head (fdd61c2) 95.35%.
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #266   +/-   ##
=======================================
  Coverage   95.34%   95.35%           
=======================================
  Files          60       60           
  Lines        3096     3097    +1     
=======================================
+ Hits         2952     2953    +1     
  Misses        144      144           
Files Coverage Δ
pyirf/binning.py 96.66% <ø> (ø)
pyirf/cuts.py 95.83% <ø> (ø)

... and 1 file with indirect coverage changes

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

pyirf/binning.py Outdated Show resolved Hide resolved
Clarified the documentation of the  "valid" return value
@Tobychev Tobychev merged commit 58b65a7 into main Oct 30, 2023
9 checks passed
@maxnoe maxnoe deleted the doc-fix branch October 30, 2023 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants