The automaton support for FuzzyQuery added the severe limitation to FuzzyQuery 
of an editing distance of 2 that needs to be documented in the Javadoc. A 
reference to SlowFuzzyQuery is also needed in the Javadoc, even though that 
class is deprecated.

The constructor Javadoc does say “maxEdits - must be >= 0 and <= 
LevenshteinAutomata.MAXIMUM_SUPPORTED_DISTANCE”, but neither the text nor that 
link documents the extreme limitation of 2. I mean, a casual reader might 
reasonably expect that it is just some big number like Integer.MAX_VALUE. The 
rationale from the Jira should be succinctly stated, at the class level as well.

Relevant Jira:
https://issues.apache.org/jira/browse/LUCENE-4024

-- Jack Krupansky

Reply via email to