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

[DOC] Seperated Notes and References #2291

Merged
merged 8 commits into from
Nov 2, 2024

Conversation

aryanpola
Copy link
Contributor

What does this implement/fix? Explain your changes.

Fixes #2280
Separated Notes and References.

@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I did not find any labels to add based on the title. Please add the [ENH], [MNT], [BUG], [DOC], [REF], [DEP] and/or [GOV] tags to your pull requests titles. For now you can add the labels manually.
This PR changes too many different packages (>3) for automatic addition of labels, please manually add package labels if relevant.

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

@aryanpola aryanpola changed the title Seperated Notes and References [DOC]Seperated Notes and References Nov 2, 2024
@hadifawaz1999 hadifawaz1999 changed the title [DOC]Seperated Notes and References [DOC] Seperated Notes and References Nov 2, 2024
Copy link
Member

@MatthewMiddlehurst MatthewMiddlehurst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you put the notes section above references

@aryanpola
Copy link
Contributor Author

@MatthewMiddlehurst any reason for the error?

@hadifawaz1999
Copy link
Member

@MatthewMiddlehurst any reason for the error?

no reason, random fail, re-ran the failed job

Copy link
Contributor

@TonyBagnall TonyBagnall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks

@hadifawaz1999 hadifawaz1999 merged commit 03c6cd2 into aeon-toolkit:main Nov 2, 2024
15 checks passed
@aryanpola aryanpola deleted the notes branch November 2, 2024 16:16
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.

[DOC] Replace NOTES by REFERENCES in docstrings
4 participants