diff --git a/src/edit.jl b/src/edit.jl index 8bf98dc..88d856f 100755 --- a/src/edit.jl +++ b/src/edit.jl @@ -1,7 +1,7 @@ """ Jaro() -Creates the Jaro metric +Creates the Jaro distance The Jaro distance is defined as @@ -53,7 +53,7 @@ end """ Levenshtein() -Creates the Levenshtein metric +Creates the Levenshtein distance The Levenshtein distance is the minimum number of operations (consisting of insertions, deletions, substitutions of a single character) required to change one string into the other. @@ -98,7 +98,7 @@ end """ DamerauLevenshtein() -Creates the restricted DamerauLevenshtein metric +Creates the restricted DamerauLevenshtein distance The DamerauLevenshtein distance is the minimum number of operations (consisting of insertions, deletions or substitutions of a single character, or transposition of two adjacent characters) @@ -170,7 +170,7 @@ end """ RatcliffObershelp() -Creates the RatcliffObershelp metric +Creates the RatcliffObershelp distance The distance between two strings is defined as one minus the number of matching characters divided by the total number of characters in the two strings. Matching characters are those diff --git a/src/normalize.jl b/src/normalize.jl index 6fe927f..48cff75 100755 --- a/src/normalize.jl +++ b/src/normalize.jl @@ -40,7 +40,7 @@ end """ Winkler(dist; p::Real = 0.1, threshold::Real = 0.7, maxlength::Integer = 4) -Creates the `Winkler{dist, p, threshold, maxlength}` distance +Creates the `Winkler{dist, p, threshold, maxlength}` distance. `Winkler{dist, p, threshold, length)` modifies the string distance `dist` to decrease the distance between two strings, when their original distance is below some `threshold`. @@ -75,7 +75,7 @@ end """ Partial(dist) -Creates the `Partial{dist}` distance +Creates the `Partial{dist}` distance. `Partial{dist}` modifies the string distance `dist` to return the minimum distance between the shorter string and substrings of the longer string @@ -134,7 +134,7 @@ end """ TokenSort(dist) -Creates the `TokenSort{dist}` distance +Creates the `TokenSort{dist}` distance. `TokenSort{dist}` modifies the string distance `dist` to adjust for differences in word orders by reording words alphabetically. @@ -166,7 +166,7 @@ end """ TokenSet(dist) -Creates the `TokenSet{dist}` distance +Creates the `TokenSet{dist}` distance. `TokenSet{dist}` modifies the string distance `dist` to adjust for differences in word orders and word numbers by comparing the intersection of two strings with each string. diff --git a/src/qgram.jl b/src/qgram.jl index 804e2e8..b4c9d4d 100755 --- a/src/qgram.jl +++ b/src/qgram.jl @@ -85,7 +85,7 @@ abstract type QGramDistance <: SemiMetric end """ QGram(q::Int) -Creates a QGram metric. +Creates a QGram distance. The distance corresponds to @@ -110,7 +110,7 @@ end """ Cosine(q::Int) -Creates a Cosine metric. +Creates a Cosine distance. The distance corresponds to @@ -137,7 +137,7 @@ end """ Jaccard(q::Int) -Creates a Jaccard metric. +Creates a Jaccard distance. The distance corresponds to @@ -163,7 +163,7 @@ end """ SorensenDice(q::Int) -Creates a SorensenDice metric +Creates a SorensenDice distance. The distance corresponds to @@ -189,7 +189,7 @@ end """ Overlap(q::Int) -Creates a Overlap metric +Creates a Overlap distance. The distance corresponds to