Skip to content

Commit 51187a3

Browse files
eksperimentaljosevalim
authored andcommitted
Touch-ups to String.jaro_distance/2 (#8506)
1 parent f43d909 commit 51187a3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

lib/elixir/lib/string.ex

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2343,22 +2343,22 @@ defmodule String do
23432343
end
23442344

23452345
@doc """
2346-
Computes the jaro distance (similarity) between two strings.
2346+
Computes the Jaro distance (similarity) between two strings.
23472347
2348-
Returns a float value between 0 (equates to no similarity) and 1
2348+
Returns a float value between `0.0` (equates to no similarity) and `1.0`
23492349
(is an exact match) representing [Jaro](https://en.wikipedia.org/wiki/Jaro-Winkler_distance)
23502350
distance between `string1` and `string2`.
23512351
23522352
The Jaro distance metric is designed and best suited for short
23532353
strings such as person names. Elixir itself uses this function
2354-
to provide "did you mean?" functionality. For instance, when you
2354+
to provide the "did you mean?" functionality. For instance, when you
23552355
are calling a function in a module and you have a typo in the
23562356
function name, we attempt to suggest the most similar function
23572357
name available, if any, based on the `jaro_distance/2` score.
23582358
23592359
## Examples
23602360
2361-
iex> String.jaro_distance("dwayne", "duane")
2361+
iex> String.jaro_distance("Dwayne", "Duane")
23622362
0.8222222222222223
23632363
iex> String.jaro_distance("even", "odd")
23642364
0.0

0 commit comments

Comments
 (0)