[DOC] Add examples to validation utility functions#3225
Merged
SebastianSchmidl merged 2 commits intoaeon-toolkit:mainfrom Feb 5, 2026
Merged
[DOC] Add examples to validation utility functions#3225SebastianSchmidl merged 2 commits intoaeon-toolkit:mainfrom
SebastianSchmidl merged 2 commits intoaeon-toolkit:mainfrom
Conversation
Added Examples sections to is_series, get_n_timepoints, and get_n_channels functions to help users understand how to use them.
Contributor
Thank you for contributing to
|
SebastianSchmidl
approved these changes
Feb 5, 2026
Member
|
You can use the @all-contributors bot to add yourself as a contributor for documentation. |
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
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.
Reference Issues/PRs
No existing issue - found while exploring the codebase.
What does this implement/fix?
Adds
Examplessections to utility functions inaeon/utils/validation/series.pythat were missing usage examples:is_series()get_n_timepoints()get_n_channels()The examples follow the existing numpydoc style in the file and demonstrate common usage patterns with NumPy arrays and pandas objects.
Does your contribution introduce a new dependency?
No.
Any other comments?
While exploring the codebase, I noticed these utilities were missing examples, so I added them to improve clarity and consistency with similar functions. This is my first contribution to aeon.