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

Correct typos in docstrings #269

Merged
merged 3 commits into from
Nov 27, 2023
Merged

Correct typos in docstrings #269

merged 3 commits into from
Nov 27, 2023

Conversation

morcuended
Copy link
Member

No description provided.

@RuneDominik
Copy link
Member

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.

@morcuended
Copy link
Member Author

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

maxnoe
maxnoe previously approved these changes Nov 27, 2023
@morcuended morcuended added the no-changelog-needed Minor change, no newsfragment/changelog needed label Nov 27, 2023
Copy link

codecov bot commented Nov 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

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
@@           Coverage Diff           @@
##             main     #269   +/-   ##
=======================================
  Coverage   95.36%   95.36%           
=======================================
  Files          60       60           
  Lines        3109     3109           
=======================================
  Hits         2965     2965           
  Misses        144      144           

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

@morcuended
Copy link
Member Author

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.

@morcuended morcuended requested a review from maxnoe November 27, 2023 11:01
@maxnoe maxnoe merged commit 571889f into main Nov 27, 2023
9 of 10 checks passed
@maxnoe maxnoe deleted the typos branch November 27, 2023 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog-needed Minor change, no newsfragment/changelog needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants