Skip to content

Commit c06d439

Browse files
committed
docs: minor fixes at readme examples
1 parent aaade39 commit c06d439

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -108,13 +108,13 @@ Restrict the list of algorithms by name or metric and/or unit.
108108

109109
```elixir
110110
iex> opts = [algorithms: ["bag_distance", "jaccard", "jaro_winkler"]]
111-
iex> Akin.compare("weird", "wierd", opts])
111+
iex> Akin.compare("weird", "wierd", opts)
112112
%{
113113
bag_distance: 1.0,
114114
jaccard: 0.14,
115115
jaro_winkler: 0.94
116116
}
117-
iex> opts = [metric: "phonetic", unit: whole]
117+
iex> opts = [algorithms: [metric: "phonetic", unit: "whole"]]
118118
iex > Akin.compare("weird", "wierd", opts)
119119
%{
120120
double_metaphone: 1.0,
@@ -169,13 +169,20 @@ iex> Akin.compare("write", "writing", [algorithms: ["bag_distance", "double_meta
169169
##### Additional Examples
170170

171171
```elixir
172-
iex> Akin.compare("weird", "wierd", [algorithms: "bag_distance", "jaro_winkler", "jaccard"])
172+
iex> Akin.compare("weird", "wierd", algorithms: ["bag_distance", "jaro_winkler", "jaccard"])
173173
%{bag_distance: 1.0, jaccard: 0.14, jaro_winkler: 0.94}
174174
```
175175

176176
```elixir
177-
iex> Akin.compare("weird", "wierd", [ngram_size: 1, metric: "string", unit: "whole"])
178-
%{jaccard: 0.67}
177+
iex> Akin.compare("weird", "wierd", algorithms: [metric: "string", unit: "whole"], ngram_size: 1)
178+
%{
179+
bag_distance: 1.0,
180+
jaccard: 0.67,
181+
jaro_winkler: 0.94,
182+
levenshtein: 0.6,
183+
sorensen_dice: 0.8,
184+
tversky: 1.0
185+
}
179186
```
180187

181188
### Preprocessing

0 commit comments

Comments
 (0)