-
Notifications
You must be signed in to change notification settings - Fork 122
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
Improve the docs of the filter()
arguments
#870
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #870 +/- ##
=====================================
Coverage 95.0% 95.0%
=====================================
Files 64 64
Lines 6134 6191 +57
=====================================
+ Hits 5828 5884 +56
- Misses 306 307 +1 ☔ View full report in Codecov by Sentry. |
ff436a2
to
802f8ae
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me in principle. I think it would be easier for the users if you had a short example of each filter. You could use the same data frame every time and filter in different ways.
Thanks @phackstock - agree that we should extend the docs to include examples and I'll start an issue for it to be tackled before release 3.0, but for now, my aim was to get the docs out of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the clarification @danielhuppmann, in this case I'd say good to merge.
Please confirm that this PR has done the following:
Tests AddedName of contributors Added to AUTHORS.rstDescription of PR
This PR moves the documentation of the filter options/arguments to an own page of the docs rather that having them as part of the
slice()
docstring.