mirrors
/
StringDistances.jl
mirror of https://github.com/matthieugomez/StringDistances.jl.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README.md

pull/17/head
matthieugomez 2019-08-20 13:28:01 -04:00
parent c6bd00f8b9
commit 14618359cb
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -91,13 +91,13 @@ The package includes distance "modifiers", that can be applied to any distance.
## Find
`find_best` returns the element of an iterator with the highest similarity score with a string
`find_best` returns the element of an iterator with the highest similarity score
```julia
find_best("New York", ["NewYork", "Newark", "San Francisco"], Levenshtein())
#> "NewYork"
```
`find_all` returns a collection of all the elements of an iterator with a similarity score higher than a minimum value (default to 0.8)
`find_all` returns all the elements of an iterator with a similarity score higher than a minimum value (default to 0.8)
```julia
find_all("New York", ["NewYork", "Newark", "San Francisco"], Levenshtein(); min_score = 0.8)