siddharthteotia commented on a change in pull request #5444: URL: https://github.com/apache/incubator-pinot/pull/5444#discussion_r432323606
########## File path: pinot-core/src/main/java/org/apache/pinot/core/common/BlockDocIdSet.java ########## @@ -18,9 +18,15 @@ */ package org.apache.pinot.core.common; +/** + * The interface <code>BlockDocIdSet</code> represents all the matching document ids for a predicate. Review comment: +1000 on removing this. ########## File path: pinot-core/src/main/java/org/apache/pinot/core/common/BlockDocIdIterator.java ########## @@ -25,25 +25,16 @@ public interface BlockDocIdIterator { /** - * Get the next document id. - * - * @return Next document id or EOF if there is no more documents + * Returns the next matched document id, or {@link Constants#EOF} if there is no more matched document. + * <p>NOTE: There should be no more call to this method after it returns {@link Constants#EOF}. */ int next(); /** - * Advance to the first document whose id is equal or greater than the given target document id. - * <p>If the given target document id is smaller or equal to the current document id, then return the current one. - * - * @param targetDocId The target document id - * @return First document id that is equal or greater than target or EOF if no document matches + * Returns the first matched document whose id is equal to or greater than the given target document id, or + * {@link Constants#EOF} if there is no such document. + * <p>NOTE: The target document id should be greater than the document id previous returned. Review comment: What happens from an API point of view if the target is same as last returned matching docId? We won't throw error and return the target as is. So, the comment should state greater than or equal to. ---------------------------------------------------------------- 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 --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org