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.

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

Update fuzzy.md #7842

Merged
merged 4 commits into from
Jul 30, 2024
Merged

Update fuzzy.md #7842

merged 4 commits into from
Jul 30, 2024

Conversation

svitlo
Copy link
Contributor

@svitlo svitlo commented Jul 26, 2024 •
edited
Loading

Corrected the name of the string metric used by default

Description

The string measure used by default is called Damerau-Levenshtein distance, because transitions are not allowed in the definition of Levenshtein distance.

Issues Resolved

No issues resolved

Version

All

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@github-actions GitHub Actions
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@svitlo
Copy link
Contributor Author

svitlo commented Jul 26, 2024

@hdhalter, now I am really ready for your doc review.

@hdhalter hdhalter added 4 - Doc review PR: Doc review in progress backport 2.15 labels Jul 26, 2024
@hdhalter hdhalter assigned kolchfa-aws and unassigned hdhalter Jul 26, 2024
kolchfa-aws
kolchfa-aws reviewed Jul 26, 2024
View reviewed changes
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @svitlo! A couple of suggestions:

  • Please change line 17 to Damerau-Levenshtein as well.
  • Since there is a transpositions parameter to allow/disallow transpositions, I think we should include a sentence about the ability to disable transpositions and make it a true Levenshtein distance. Maybe on the same line 17?

@svitlo
Copy link
Contributor Author

svitlo commented Jul 27, 2024 •
edited
Loading

  • Please change line 17 to Damerau-Levenshtein as well.

Done

  • Since there is a transpositions parameter to allow/disallow transpositions, I think we should include a sentence about the ability to disable transpositions and make it a true Levenshtein distance. Maybe on the same line 17?

Agree. Done.

@svitlo
Copy link
Contributor Author

svitlo commented Jul 27, 2024

@kolchfa-aws, could you please review my amendment.

@svitlo
Copy link
Contributor Author

svitlo commented Jul 27, 2024 •
edited
Loading

@kolchfa-aws, I corrected the line 17 one more time to not break the thought regarding the usage of the field 'max_expansions'.

Could you please review it.

@svitlo svitlo mentioned this pull request Jul 27, 2024
Merged
1 task
kolchfa-aws
kolchfa-aws approved these changes Jul 29, 2024
View reviewed changes
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @svitlo! One rewording suggestion. Also, please fix DCO.

_query-dsl/term/fuzzy.md Outdated Show resolved Hide resolved
@svitlo
Update fuzzy.md
49933a3 
Corrected the name of the string metric used by default

Signed-off-by: Tim <[email protected]>
Signed-off-by: svitlo <[email protected]>
@svitlo
Copy link
Contributor Author

svitlo commented Jul 30, 2024

Also, please fix DCO.

@kolchfa-aws, fixed.

@kolchfa-aws
Copy link
Collaborator

@svitlo Looks like you've picked up a few extraneous commits along the way :) Please rebase and push again.

@svitlo
Copy link
Contributor Author

svitlo commented Jul 30, 2024 •
edited
Loading

Please rebase and push again.

Done.

Could you please check.

@svitlo
Copy link
Contributor Author

svitlo commented Jul 30, 2024

@kolchfa-aws, ^

@kolchfa-aws
Copy link
Collaborator

Hmmmmm.... I can still see others' commits in this PR https://github.com/opensearch-project/documentation-website/pull/7842/commits

@svitlo
Copy link
Contributor Author

svitlo commented Jul 30, 2024

@kolchfa-aws, how can I fix it?

@kolchfa-aws
Copy link
Collaborator

Try rebasing the last 10 commits on your branch against main using this guide https://docs.github.com/en/get-started/using-git/about-git-rebase (so start with running git rebase --interactive HEAD~10). Let me know if you need help.

svitlo and others added 3 commits July 30, 2024 20:17
@svitlo
correct the line 17 of fuzzy.md to clarify the distance name and the …
02c8ec6 
…role of the field 'transpositions'

Signed-off-by: svitlo <[email protected]>
@svitlo
correct the line 17 to not break the thought regarding the usage of t…
83b32b5 
…he field 'max_expansions'

Signed-off-by: svitlo <[email protected]>
@svitlo @kolchfa-aws
Update _query-dsl/term/fuzzy.md
6ac0870 
Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Tim <[email protected]>
Signed-off-by: svitlo <[email protected]>
@svitlo
Copy link
Contributor Author

svitlo commented Jul 30, 2024

@kolchfa-aws, I followed your recommendations.

@kolchfa-aws
Copy link
Collaborator

Awesome, thanks! 🚢

@kolchfa-aws kolchfa-aws merged commit 3dcff57 into opensearch-project:main Jul 30, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 30, 2024
@github-actions @kolchfa-aws
Update fuzzy.md (#7842)
096756e 
* Update fuzzy.md

Corrected the name of the string metric used by default

Signed-off-by: Tim <[email protected]>
Signed-off-by: svitlo <[email protected]>

* correct the line 17 of fuzzy.md to clarify the distance name and the role of the field 'transpositions'

Signed-off-by: svitlo <[email protected]>

* correct the line 17 to not break the thought regarding the usage of the field 'max_expansions'

Signed-off-by: svitlo <[email protected]>

* Update _query-dsl/term/fuzzy.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Tim <[email protected]>
Signed-off-by: svitlo <[email protected]>

---------

Signed-off-by: Tim <[email protected]>
Signed-off-by: svitlo <[email protected]>
Co-authored-by: svitlo <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
(cherry picked from commit 3dcff57)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Jul 30, 2024
Merged
github-actions bot pushed a commit that referenced this pull request Jul 30, 2024
@opensearch-trigger-bot
Update fuzzy.md (#7842) (#7870)
e55c20b
@svitlo svitlo deleted the patch-1 branch July 31, 2024 15:18
mingshl pushed a commit to mingshl/documentation-website that referenced this pull request Aug 2, 2024
@svitlo @kolchfa-aws @mingshl
Update fuzzy.md (opensearch-project#7842)
d85853e 
* Update fuzzy.md

Corrected the name of the string metric used by default

Signed-off-by: Tim <[email protected]>
Signed-off-by: svitlo <[email protected]>

* correct the line 17 of fuzzy.md to clarify the distance name and the role of the field 'transpositions'

Signed-off-by: svitlo <[email protected]>

* correct the line 17 to not break the thought regarding the usage of the field 'max_expansions'

Signed-off-by: svitlo <[email protected]>

* Update _query-dsl/term/fuzzy.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Tim <[email protected]>
Signed-off-by: svitlo <[email protected]>

---------

Signed-off-by: Tim <[email protected]>
Signed-off-by: svitlo <[email protected]>
Co-authored-by: svitlo <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kolchfa-aws kolchfa-aws kolchfa-aws approved these changes

@hdhalter hdhalter Awaiting requested review from hdhalter

@Naarcha-AWS Naarcha-AWS Awaiting requested review from Naarcha-AWS Naarcha-AWS is a code owner

@vagimeli vagimeli Awaiting requested review from vagimeli

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@natebower natebower Awaiting requested review from natebower natebower is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@stephen-crawford stephen-crawford Awaiting requested review from stephen-crawford

@epugh epugh Awaiting requested review from epugh epugh is a code owner

Assignees

@kolchfa-aws kolchfa-aws

Labels
4 - Doc review PR: Doc review in progress backport 2.15
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@svitlo @kolchfa-aws @hdhalter