Skip to content

[DOC] Fix incorrect references from "Getting Started" page #2761

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.

Sign up for GitHub

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

Jump to bottom
Open
Kaustbh opened this issue Apr 23, 2025 · 3 comments · May be fixed by #2762
Open

[DOC] Fix incorrect references from "Getting Started" page #2761

Kaustbh opened this issue Apr 23, 2025 · 3 comments · May be fixed by #2762
Assignees
@inclinedadarsh
Labels
documentation Improvements or additions to documentation

Comments

@Kaustbh
Copy link
Contributor

Kaustbh commented Apr 23, 2025

Describe the issue linked to the documentation

There are several incorrect or outdated references/links in the Getting Started documentation page:

  1. aeon/docs/getting_started.md

    Line 317 in 34445eb

    The estimators are inheriting from the [BaseSimiliaritySearch](similarity_search.base.BaseSimiliaritySearch)

  2. aeon/docs/getting_started.md

    Line 359 in 34445eb

    Transformers inheriting from the [BaseSeriesTransformer](transformations.base.BaseSeriesTransformer)

  3. aeon/docs/getting_started.md

    Line 388 in 34445eb

    [Catch22](transformations.collection.feauture_based), which calculates 22 summary

  4. aeon/docs/getting_started.md

    Line 406 in 34445eb

    [Padder](transformations.collection) to lengthen

  5. aeon/docs/getting_started.md

    Line 441 in 34445eb

    The following example uses the [Catch22](transformations.collection.catch22.Catch22)

Suggest a potential alternative/fix

No response
@Kaustbh Kaustbh added the documentation Improvements or additions to documentation label Apr 23, 2025
@inclinedadarsh inclinedadarsh linked a pull request Apr 24, 2025 that will close this issue
Open
2 tasks
@inclinedadarsh
Copy link
Contributor

I have raised a PR at #2762

@inclinedadarsh
Copy link
Contributor

@aeon-actions-bot assign @inclinedadarsh

@aeon-actions-bot
Copy link
Contributor

@inclinedadarsh, you already have 3 open issues assigned.Users without write access are limited to self-assigning twoissues.

Here are the open issues assigned to you:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@inclinedadarsh inclinedadarsh

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOC] fix incorrect references of classes in getting started page inclinedadarsh/aeon
2 participants
@inclinedadarsh @Kaustbh