Skip to content

[DOC] Fix typos and enhance clarity in getting_started.md#3134

Merged
MatthewMiddlehurst merged 3 commits intoaeon-toolkit:mainfrom
PoojasPatel013:main
Dec 29, 2025
Merged

[DOC] Fix typos and enhance clarity in getting_started.md#3134
MatthewMiddlehurst merged 3 commits intoaeon-toolkit:mainfrom
PoojasPatel013:main

Conversation

@PoojasPatel013
Copy link
Copy Markdown
Contributor

@PoojasPatel013 PoojasPatel013 commented Nov 24, 2025

While working through the getting_started.md guide to familiarize myself with the project, I encountered a few typos, a formatting issue.

Detailed Changes

1. Fix Garbled Text in "Segmentation" Description (Line 34)

Issue: The description for the Segmentation module was unclear and contained the phrase "sofind areas...", which appears to be a text-editor artifact or copy-paste error.
Fix: Replaced the confusing sentence with a precise definition.

Before: "...sofind areas..."
After: "...series into regions that are dissimilar to each other."

2. Grammar Correction (Line 40)

Issue: A redundant article was present in the sentence structure.
Fix: Removed the extra "a".

Before: "...where a either a single series..."
After: "...where either a single series..."

3. List Indentation Fix (Line 45)

Issue: The "Networks" list item was not indented correctly, causing it to break the visual hierarchy of the module list.
Fix: Adjusted whitespace to align "Networks" with the preceding and succeeding list items.

4. Spelling Correction (Line 203)

Issue: The word "multivariate" was misspelled.
Fix: Corrected spelling.

Before: "...mutlivariate..."
After: "...multivariate..."

Corrected typos and improved clarity in the documentation.
@aeon-actions-bot
Copy link
Copy Markdown
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.

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
  • Regenerate expected results for testing
  • Push an empty commit to re-run CI checks

@PoojasPatel013 PoojasPatel013 changed the title Fix typos and enhance clarity in getting_started.md [DOC] Fix typos and enhance clarity in getting_started.md Nov 24, 2025
@MatthewMiddlehurst
Copy link
Copy Markdown
Member

Thanks, agree with the changes and fixes

@MatthewMiddlehurst MatthewMiddlehurst merged commit 3057547 into aeon-toolkit:main Dec 29, 2025
3 checks passed
@MatthewMiddlehurst
Copy link
Copy Markdown
Member

@all-contributors add @PoojasPatel013 for docs

@allcontributors
Copy link
Copy Markdown
Contributor

@MatthewMiddlehurst

I've put up a pull request to add @PoojasPatel013! 🎉

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.

2 participants