Skip to content

[BUG] Improve signature docs #2929

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

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

[BUG] Improve signature docs #2929

wants to merge 22 commits into from

Conversation

TonyBagnall
Copy link
Contributor

@TonyBagnall TonyBagnall commented Jul 4, 2025

fixes #2840

Two people have recently told me they were using signatures. This will tidy up signature docs, not sure if we can find the missing image though.

was scope creeping into changing the code reverted to just do the docs

I've removed the example that relied on a non existent image. Ive checked, it never existed and there are two issues in the other place noting its absence. I've added a link to a medium post and James Morill's thesis

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@aeon-actions-bot aeon-actions-bot bot added bug Something isn't working examples Example notebook related transformations Transformations package labels Jul 4, 2025
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ bug ].
I have added the following labels to this PR based on the changes made: [ examples, transformations ]. Feel free to change these if they do not properly represent the PR.

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 Slack 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
  • Push an empty commit to re-run CI checks

@TonyBagnall TonyBagnall marked this pull request as ready for review July 12, 2025 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working examples Example notebook related transformations Transformations package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Missing image and equations from signature method docs
1 participant