From 9e066e3c5ab301da0d910e34ba8a9349ea195e5c Mon Sep 17 00:00:00 2001 From: matthieugomez Date: Mon, 9 Nov 2015 14:40:13 -0500 Subject: [PATCH] care --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f17af26..db2c3d5 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ evaluate(QGram(2), "martha", "marhta") ``` #### compare -The higher level function `compare` returns *a similarity score* between two strings. The similarity score is always between 0 and 1. A value of 0 being completely different and a value of 1 being completely similar. +The higher level function `compare` returns *a similarity score* between two strings. The similarity score is always between 0 and 1. A value of 0 being completely different and a value of 1 being completely similar. The output of compare is generally 1 - normalized distance, with some care for `NaN` values. ```julia using StringDistances compare(Hamming(), "martha", "marhta")