-
Notifications
You must be signed in to change notification settings - Fork 197
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] Fix inconsistent double backticks in similarity_search module (#809) #2618
base: main
Are you sure you want to change the base?
[DOC] Fix inconsistent double backticks in similarity_search module (#809) #2618
Conversation
Thank you for contributing to
|
3cd3b42
to
a78512d
Compare
Hi @baraline, it looks like tj-actions/changed-files@v45 couldn't be fetched, possibly due to a version issue. Updating it to v44 or v46 in .github/workflows/pre-commit.yml might help. Let me know how to proceed! |
Hi, I'd wait for #2473 to be in for this PR to go through, as it will rework the module completely. Regarding the precommit issue, this is something we'll fix as it is currently affecting other PRs |
This PR addresses issue #809 by standardizing the use of double backticks (``) for inline code references in the similarity_search module. Previously, some docstrings inconsistently used single backticks (`), which rendered text as italics instead of formatted code.
Changes made:
Replaced inconsistent single backticks with double backticks for inline code references.
Ensured uniform formatting across the following files:
aeon/similarity_search/base.py
aeon/similarity_search/distance_profiles/euclidean_distance_profile.py
aeon/similarity_search/distance_profiles/squared_distance_profile.py
aeon/similarity_search/matrix_profiles/stomp.py
aeon/similarity_search/query_search.py
aeon/similarity_search/series_search.py
Maintained readability and adherence to the Aeon documentation guidelines.
This update improves the clarity of API documentation and aligns with the preferred style for referring to code elements.