[
https://issues.apache.org/jira/browse/TEXT-166?focusedWorklogId=316293&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-316293
]
ASF GitHub Bot logged work on TEXT-166:
---------------------------------------
Author: ASF GitHub Bot
Created on: 22/Sep/19 17:43
Start Date: 22/Sep/19 17:43
Worklog Time Spent: 10m
Work Description: mikkomaunu commented on pull request #121: [TEXT-166]
removed non-existing parameter from Javadocs and spelled out parameters in
throws
URL: https://github.com/apache/commons-text/pull/121
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
Issue Time Tracking
-------------------
Worklog Id: (was: 316293)
Remaining Estimate: 0h
Time Spent: 10m
> FuzzyScore JavaDoc mistake
> --------------------------
>
> Key: TEXT-166
> URL: https://issues.apache.org/jira/browse/TEXT-166
> Project: Commons Text
> Issue Type: Task
> Reporter: Ben Manes
> Priority: Trivial
> Time Spent: 10m
> Remaining Estimate: 0h
>
> {{FuzzyScore}} was adapted from {{StringUtils#getFuzzyDistance}} and the
> JavaDoc was copied as is. The deprecated utility method took three arguments
> (term, query, locale). The class takes {{locale}} as a constructor argument
> and the remaining as method arguments. However, the JavaDoc was unchanged and
> shows the {{locale}} method parameter.
> {code:java}
> /**
> * <p>
> * Find the Fuzzy Score which indicates the similarity score between two
> * Strings.
> * </p>
> *
> * <pre>
> * score.fuzzyScore(null, null, null) = IllegalArgumentException
> * score.fuzzyScore("", "", Locale.ENGLISH) = 0
> * score.fuzzyScore("Workshop", "b", Locale.ENGLISH) = 0
> * score.fuzzyScore("Room", "o", Locale.ENGLISH) = 1
> * score.fuzzyScore("Workshop", "w", Locale.ENGLISH) = 1
> * score.fuzzyScore("Workshop", "ws", Locale.ENGLISH) = 2
> * score.fuzzyScore("Workshop", "wo", Locale.ENGLISH) = 4
> * score.fuzzyScore("Apache Software Foundation", "asf", Locale.ENGLISH) = 3
> * </pre>
> *
> * @param term a full term that should be matched against, must not be null
> * @param query the query that will be matched against a term, must not be
> * null
> * @return result score
> * @throws IllegalArgumentException if either CharSequence input is {@code
> null}
> */
> public Integer fuzzyScore(final CharSequence term, final CharSequence query)
> {{code}
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
