[
https://issues.apache.org/jira/browse/LANG-1269?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15597562#comment-15597562
]
ASF GitHub Bot commented on LANG-1269:
--------------------------------------
GitHub user PascalSchumacher opened a pull request:
https://github.com/apache/commons-lang/pull/198
LANG-1269: Wrong name or result of StringUtils#getJaroWinklerDistance
deprecat StringUtils#getJaroWinklerDistance and add
StringUtils#getJaroWinklerSimilarity instead
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/PascalSchumacher/commons-lang
jarowinklerdistance_name
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/commons-lang/pull/198.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #198
----
commit d2e6338a8ec46ebc80156ef9dcdd83dfe63ee8b5
Author: pascalschumacher <[email protected]>
Date: 2016-10-22T09:55:32Z
LANG-1269: Wrong name or result of StringUtils#getJaroWinklerDistance
deprecat StringUtils#getJaroWinklerDistance and add
StringUtils#getJaroWinklerSimilarity instead
----
> Wrong name or result of StringUtils::getJaroWinklerDistance
> -----------------------------------------------------------
>
> Key: LANG-1269
> URL: https://issues.apache.org/jira/browse/LANG-1269
> Project: Commons Lang
> Issue Type: Bug
> Affects Versions: 3.3, 3.4
> Reporter: Jan Martin Keil
> Assignee: Bruno P. Kinoshita
> Priority: Minor
>
> The name of the method StringUtils::getJaroWinklerDistance is misleading.
> Currently for equal strings {{1}} is returned, for completely different
> strings {{0}} is returned. That is a measure of similarity, not of a
> distance. A distance must be {{0}} for equal strings. I read on the issues
> LANG-591 and LANG-944, that it was decided to have a similar name to
> StringUtils::getLevenshteinDistance, but that requires also the change of the
> methods result.
> Could you please (1) rename the method to
> StringUtils::getJaroWinklerSimilarity or (2) change the method to return {{1
> - currentResult}}?
> First option has the disadvantage to lose the similar naming of the similar
> methods, second option implies the risk to unnoticed introduce bugs in
> depending code. So I think it is preferable to use the first option.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
