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

Improve the docs of the filter() arguments #870

Merged
merged 3 commits into from
Aug 7, 2024

Conversation

danielhuppmann
Copy link
Member

@danielhuppmann danielhuppmann commented Aug 6, 2024

Please confirm that this PR has done the following:

  • Tests Added
  • Documentation Added
  • Name of contributors Added to AUTHORS.rst
  • Description in RELEASE_NOTES.md Added

Description 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.

@danielhuppmann danielhuppmann self-assigned this Aug 6, 2024
Copy link

codecov bot commented Aug 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.0%. Comparing base (ddbb88e) to head (802f8ae).
Report is 28 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@danielhuppmann danielhuppmann marked this pull request as ready for review August 6, 2024 11:55
Copy link
Contributor

@phackstock phackstock left a 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.

docs/api/filtering.rst Show resolved Hide resolved
docs/api/filtering.rst Show resolved Hide resolved
@danielhuppmann
Copy link
Member Author

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 core.py.

Copy link
Contributor

@phackstock phackstock left a 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.

@danielhuppmann danielhuppmann merged commit bfdc8b6 into IAMconsortium:main Aug 7, 2024
14 checks passed
@danielhuppmann danielhuppmann deleted the docs/filter branch August 7, 2024 10:24
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.

2 participants