Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-8283

Improve FieldOffsetStrategy javadoc post-OffsetsEnum change

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 7.3.1, 8.0
    • Fix Version/s: 7.4
    • Component/s: None
    • Labels:
      None
    • Lucene Fields:
      New, Patch Available

      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.

        Attachments

        1. LUCENE-8283.patch
          0.8 kB
          Michael Braun

          Issue Links

            Activity

              People

              • Assignee:
                dsmiley David Smiley
                Reporter:
                mbraun688 Michael Braun
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: