Merge pull request #19766 from vespa-engine/bratseth/explain-group

Explain group

3 files changed, 11 insertions, 11 deletions

diff --git a/container-search/src/main/java/com/yahoo/search/dispatch/searchcluster/Group.java b/container-search/src/main/java/com/yahoo/search/dispatch/searchcluster/Group.java
index 8ae892bc664..7415426eb69 100644
--- a/container-search/src/main/java/com/yahoo/search/dispatch/searchcluster/Group.java
+++ b/container-search/src/main/java/com/yahoo/search/dispatch/searchcluster/Group.java
@@ -39,7 +39,11 @@ public class Group {
         }
     }
 
-    /** Returns the unique identity of this group */
+    /**
+     * Returns the unique identity of this group.
+     * NOTE: This is a contiguous index from 0, NOT necessarily the group id assigned
+     * by the user or node repo.
+     */
     public int id() { return id; }
 
     /** Returns the nodes in this group as an immutable list */
diff --git a/container-search/src/main/java/com/yahoo/search/dispatch/searchcluster/Node.java b/container-search/src/main/java/com/yahoo/search/dispatch/searchcluster/Node.java
index f48f1c719f4..0dce3d84273 100644
--- a/container-search/src/main/java/com/yahoo/search/dispatch/searchcluster/Node.java
+++ b/container-search/src/main/java/com/yahoo/search/dispatch/searchcluster/Node.java
@@ -54,7 +54,7 @@ public class Node {
 
     public String hostname() { return hostname; }
 
-    /** Returns the id of this group this node belongs to */
+    /** Returns the id of the group this node belongs to */
     public int group() { return group; }
 
     public void setWorking(boolean working) {
diff --git a/container-search/src/main/java/com/yahoo/search/grouping/result/Group.java b/container-search/src/main/java/com/yahoo/search/grouping/result/Group.java
index 158cf17d154..be50b572f5b 100644
--- a/container-search/src/main/java/com/yahoo/search/grouping/result/Group.java
+++ b/container-search/src/main/java/com/yahoo/search/grouping/result/Group.java
@@ -19,8 +19,8 @@ public class Group extends HitGroup {
     /**
      * Creates a new instance of this class.
      *
-     * @param groupId The id to assign to this group.
-     * @param rel     The relevance of this group.
+     * @param groupId the id to assign to this group
+     * @param rel     the relevance of this group
      */
     public Group(GroupId groupId, Relevance rel) {
         super(groupId.toString(), rel);
@@ -29,11 +29,7 @@ public class Group extends HitGroup {
         this.groupId = groupId;
     }
 
-    /**
-     * Returns the id of this group. This is a model of the otherwise flattened {@link #getId() hit id}.
-     *
-     * @return the group id
-     */
+    /** Returns the id of this group. This is a model of the otherwise flattened {@link #getId() hit id}. */
     public GroupId getGroupId() {
         return groupId;
     }
@@ -65,8 +61,8 @@ public class Group extends HitGroup {
      * com.yahoo.search.grouping.request.EachOperation} that generated the list. This method returns null if no such
      * list was found.
      *
-     * @param label The label of the list to return.
-     * @return The requested list, or null.
+     * @param label the label of the list to return
+     * @return the requested list, or null
      */
     public GroupList getGroupList(String label) {
         for (Hit hit : this) {