Skip to content

Commit 97c2b11

Browse files
authored
Fix java doc for TopGroups.mergeBlockGroups (#16302)
The java doc for TopGroups.mergeBlockGroups() is not correct, this method won't return null for null groups but return an empty TopGroups. Signed-off-by: Binlong Gao <gbinlong@amazon.com>
1 parent cf72e8d commit 97c2b11

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

  • lucene/grouping/src/java/org/apache/lucene/search/grouping

lucene/grouping/src/java/org/apache/lucene/search/grouping/TopGroups.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,8 @@ public int compare(MergedBlockGroup group, MergedBlockGroup other) {
350350
* @param groupOffset Which group to start from.
351351
* @param topNGroups How many top groups to keep.
352352
* @param docSort The sort to use within each group
353-
* @return TopGroups instance or null if there are no groups.
353+
* @return TopGroups instance; if there are no groups, returns a TopGroups with an empty groups
354+
* array.
354355
*/
355356
@SuppressWarnings("unchecked")
356357
public static <T> TopGroups<T> mergeBlockGroups(

0 commit comments

Comments
 (0)