cta-observatory / pyirf

Python IRF builder
https://pyirf.readthedocs.io/en/stable/
MIT License
15 stars 25 forks source link

Correct typos in docstrings #269

Closed morcuended closed 9 months ago

RuneDominik commented 9 months ago

Oh, that's more typos than I would have thought, thanks for going over them :sweat_smile:

Tests are failing since the typos were seemingly carried over to test the exceptions being raised correctly.

morcuended commented 9 months ago

Oh, that's more typos than I would have thought, thanks for going over them 😅

Tests are failing since the typos were seemingly carried over to test the exceptions being raised correctly.

Let me have a look

codecov[bot] commented 9 months ago

Codecov Report

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

Comparison is base (5346e00) 95.36% compared to head (9f3bd22) 95.36%. Report is 4 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #269 +/- ## ======================================= Coverage 95.36% 95.36% ======================================= Files 60 60 Lines 3109 3109 ======================================= Hits 2965 2965 Misses 144 144 ```

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

morcuended commented 9 months ago

I found also that in PSF and EDISP estimators' docstrings, was specified that they default to GridDataInterpolator instead of QuantileInterpolator. Also noticed that arguments in those classes are not properly included in the documentation since they are written after their __init__ methods instead of the docstring of the classes themselves.