[GitHub] [lucene-solr] mikemccand commented on a change in pull request #2095: LUCENE-9618: Do not call IntervalIterator.nextInterval after NO_MORE_DOCS returned

[GitBox <gi...@apache.org>]

mikemccand commented on a change in pull request #2095:
URL: https://github.com/apache/lucene-solr/pull/2095#discussion_r528930069



##########
File path: lucene/queries/src/java/org/apache/lucene/queries/intervals/IntervalIterator.java
##########
@@ -82,6 +82,11 @@ public int width() {
   /**
    * Advance the iterator to the next interval
    *
+   * Should not be called after {@link DocIdSetIterator#NO_MORE_DOCS} is returned by other methods
+   * if that's the case in some existing code, please consider opening an issue

Review comment:
       This is a new sentence -- maybe add `.` at end of previous one and capitlize `If`?

##########
File path: lucene/queries/src/java/org/apache/lucene/queries/intervals/IntervalIterator.java
##########
@@ -82,6 +82,11 @@ public int width() {
   /**
    * Advance the iterator to the next interval
    *
+   * Should not be called after {@link DocIdSetIterator#NO_MORE_DOCS} is returned by other methods

Review comment:
       Hmm maybe be more specific than `other methods`?  E.g. maybe say `returned by the query scorer's nextDoc() method`?

##########
File path: lucene/queries/src/java/org/apache/lucene/queries/intervals/IntervalIterator.java
##########
@@ -82,6 +82,11 @@ public int width() {
   /**
    * Advance the iterator to the next interval
    *
+   * Should not be called after {@link DocIdSetIterator#NO_MORE_DOCS} is returned by other methods
+   * if that's the case in some existing code, please consider opening an issue
+   * However, after {@link IntervalIterator#NO_MORE_INTERVALS} is returned by this method, it might be
+   * called again

Review comment:
       Period at end of this sentence?




----------------------------------------------------------------
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:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org