Skip to content

[DOC] Add examples to validation utility functions#3225

Merged
SebastianSchmidl merged 2 commits intoaeon-toolkit:mainfrom
nimra06:doc/add-examples-validation-functions
Feb 5, 2026
Merged

[DOC] Add examples to validation utility functions#3225
SebastianSchmidl merged 2 commits intoaeon-toolkit:mainfrom
nimra06:doc/add-examples-validation-functions

Conversation

@nimra06
Copy link
Copy Markdown
Contributor

@nimra06 nimra06 commented Jan 6, 2026

Reference Issues/PRs

No existing issue - found while exploring the codebase.

What does this implement/fix?

Adds Examples sections to utility functions in aeon/utils/validation/series.py that 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.

Added Examples sections to is_series, get_n_timepoints, and get_n_channels
functions to help users understand how to use them.
@aeon-actions-bot aeon-actions-bot bot added the documentation Improvements or additions to documentation label Jan 6, 2026
@aeon-actions-bot
Copy link
Copy Markdown
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ documentation ].

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Discord channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

  • Run pre-commit checks for all files
  • Run mypy typecheck tests
  • Run all pytest tests and configurations
  • Run all notebook example tests
  • Run numba-disabled codecov tests
  • Stop automatic pre-commit fixes (always disabled for drafts)
  • Disable numba cache loading
  • Regenerate expected results for testing
  • Push an empty commit to re-run CI checks

@SebastianSchmidl
Copy link
Copy Markdown
Member

You can use the @all-contributors bot to add yourself as a contributor for documentation.

@SebastianSchmidl SebastianSchmidl merged commit 6a4a19d into aeon-toolkit:main Feb 5, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants