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] Remove glossary #2271

Merged
merged 2 commits into from
Oct 30, 2024
Merged

[DOC] Remove glossary #2271

merged 2 commits into from
Oct 30, 2024

Conversation

TonyBagnall
Copy link
Contributor

removes the glossary.md in docs directory. As far as I can tell this is only linked from getting_started.md and it contains a lot of redundant and misleading definitions, such as "Panel" and annotation. I think it best to just get rid, seems an odd thing to have, I guess scikit have one ...

@TonyBagnall TonyBagnall added the documentation Improvements or additions to documentation label Oct 29, 2024
@aeon-actions-bot
Copy link
Contributor

Thank you for contributing to aeon

I did not find any labels to add that did not already exist. If the content of your PR changes, make sure to update the labels accordingly.

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

@MatthewMiddlehurst
Copy link
Member

could you do a search for "term" to make sure there arent any remaining references if we do this. i.e. :term:`Glossary <n_jobs>`

@TonyBagnall
Copy link
Contributor Author

could you do a search for "term" to make sure there arent any remaining references if we do this. i.e. :term:Glossary <n_jobs>

already did "As far as I can tell this is only linked from getting_started.md" as far as I cant tell is because I do not trust pycharm find that much

@TonyBagnall
Copy link
Contributor Author

TonyBagnall commented Oct 30, 2024

Glossary <n_jobs>

there is a reference to the scikit glossary here
"""Check n_jobs parameter according to the scikit-learn convention.

https://scikit-learn.org/stable/glossary.html#term-n_jobs

is that the one you meant?

ah take it back, searching :term: reveals more than searching term

@TonyBagnall TonyBagnall merged commit f48769d into main Oct 30, 2024
15 checks passed
@TonyBagnall TonyBagnall deleted the ajb/glossary branch October 30, 2024 12:27
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