Conversation
Codecov Report✅ All modified and coverable lines are covered by tests.
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request primarily updates and improves the docstrings and usage examples for the
IntervalSetandTsGroupclasses in thepynapplecodebase, ensuring that documentation reflects the current API and output formats. It also adds a new doctest job to the CI workflow to automatically test the code examples in the documentation. These changes enhance clarity, accuracy, and maintainability for both users and developers.Documentation and Example Improvements:
IntervalSetdocstrings to reflect accurate output formats, including index columns, shape, and time units, and corrected metadata handling in examples. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]TsGroupdocstrings and examples for methods such asrestrict,value_from,count,to_tsd,getby_threshold,getby_intervals, andgetby_categoryto use current output formats, metadata conventions, and correct method usage. [1] [2] [3] [4] [5] [6] [7]Continuous Integration Enhancements:
doctestjob to the GitHub Actions workflow to automatically run doctests on thepynapple/coreandpynapple/processmodules, ensuring that documentation examples remain correct. The maincheckjob now depends on this doctest job.Configuration and Miscellaneous:
numbainstead ofjax) and improved warnings documentation. [1] [2]These updates will help keep documentation reliable and ensure that code examples are always in sync with the actual API and outputs.