[LUCENE-8283] Improve FieldOffsetStrategy javadoc post-OffsetsEnum change

• Type: Improvement
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Affects Version/s: 7.3.1, 8.0
• Fix Version/s: 7.4
• Lucene Fields: New, Patch Available
• Assignee: David Smiley
• Reporter: Michael Braun
• Created: 28/Apr/18 19:33
• Updated: 28/Aug/22 15:29
• Resolved: 30/Apr/18 02:32

Description

As part of LUCENE-8145, the FieldOffsetStrategy abstract class was changed to return an OffsetsEnum rather than a List<OffsetsEnum> for getOffsetsEnum(IndexReader reader, int docId, String content). However, the javadoc at the top of the class currently reads:

Ultimately returns a list of {@link OffsetsEnum} yielding potentially highlightable words in the text....

"a list" should be replaced with "an" to be more accurate now that this method has changed signature.

Issue Links

• is related to: LUCENE-8145 UnifiedHighlighter should use single OffsetEnum rather than List<OffsetEnum>