Skip to content

DOC: fix typo in custom_alignment_path docstring#3243

Merged
SebastianSchmidl merged 2 commits intoaeon-toolkit:mainfrom
devesh-047:doc/fix-custom-alignment-path-typo-v2
Jan 24, 2026
Merged

DOC: fix typo in custom_alignment_path docstring#3243
SebastianSchmidl merged 2 commits intoaeon-toolkit:mainfrom
devesh-047:doc/fix-custom-alignment-path-typo-v2

Conversation

@devesh-047
Copy link
Copy Markdown
Contributor

This PR fixes a small typo and removes duplicated wording in the
custom_alignment_path parameter docstring.

Specifically:

  • Corrects wheewhere
  • Removes repeated use of the word documentation

This improves clarity without changing any functionality.

Closes #3230

@aeon-actions-bot aeon-actions-bot bot added clustering Clustering package documentation Improvements or additions to documentation labels Jan 16, 2026
@aeon-actions-bot
Copy link
Copy Markdown
Contributor

Thank you for contributing to aeon

I have added the following labels to this PR based on the title: [ documentation ].
I have added the following labels to this PR based on the changes made: [ clustering ]. 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 Discord 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

@manasvi-0
Copy link
Copy Markdown

Hi @devesh-047 , I’d like to take this up and submit a PR to fix the typo and clean up the duplicated wording in the docstring. Please let me know if that works.

@devesh-047
Copy link
Copy Markdown
Contributor Author

Hi @devesh-047 , I’d like to take this up and submit a PR to fix the typo and clean up the duplicated wording in the docstring. Please let me know if that works.

Hello @manasvi-0 I have already worked on a PR for this issue and am currently waiting for the maintainers to review it . You can try looking for other issues.

@SebastianSchmidl SebastianSchmidl merged commit 8f577fb into aeon-toolkit:main Jan 24, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clustering Clustering package documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] Fix typo in /clustering/_elastic_som.py

3 participants