Skip to content

docs(search): correct edit distance example #852

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

Open
IvoCrnkovic wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(search): correct edit distance example #852

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/articles/how-fuzzy-search-works.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ When you search for "javscript" and Fuse.js returns "JavaScript", it's using **a

The core idea is **edit distance**: the minimum number of single-character operations (insertions, deletions, substitutions) needed to transform one string into another.

For example, turning "javscript" into "javascript" requires:
For a three-edit example, turning "jovscript" into "javascripts" requires:

- **Substitute** `o` → `a` (at position 2)
- **Insert** `a` (at position 4)
- **Insert** `s` (at position 10)
- **Substitute** `o` with `a`: `jovscript` → `javscript`
- **Insert** `a` after `v`: `javscript` → `javascript`
- **Insert** `s` at the end: `javascript` → `javascripts`

That's an edit distance of 3. The lower the distance relative to the string length, the better the match.

Expand Down