Clarify the layout of the content array in zscan

Bit-Quill · Jun 28, 2024 · b094a56 · b094a56
1 parent 144d76e
commit b094a56
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/java/client/src/main/java/glide/api/commands/SortedSetBaseCommands.java b/java/client/src/main/java/glide/api/commands/SortedSetBaseCommands.java
@@ -1588,7 +1588,9 @@ CompletableFuture<Map<String, Double>> zinterWithScores(
      * @return An <code>Array</code> of <code>Objects</code>. The first element is always the <code>
      *     cursor</code> for the next iteration of results. <code>0</code> will be the <code>cursor
      *     </code> returned on the last iteration of the set. The second element is always an <code>
-     *     Array</code> of the subset of the set held in <code>key</code>.
+     *     Array</code> of the subset of the set held in <code>key</code>. The array in the second
+     *     element is always a flattened series of String pairs, where the value is at even indices
+     *     and the score is at odd indices.
      * @example
      *     <pre>{@code
      * // Assume key contains a set with 200 member-score pairs
@@ -1621,7 +1623,9 @@ CompletableFuture<Map<String, Double>> zinterWithScores(
      * @return An <code>Array</code> of <code>Objects</code>. The first element is always the <code>
      *     cursor</code> for the next iteration of results. <code>0</code> will be the <code>cursor
      *     </code> returned on the last iteration of the set. The second element is always an <code>
-     *     Array</code> of the subset of the set held in <code>key</code>.
+     *     Array</code> of the subset of the set held in <code>key</code>. The array in the second
+     *     element is always a flattened series of String pairs, where the value is at even indices
+     *     and the score is at odd indices.
      * @example
      *     <pre>{@code
      * // Assume key contains a set with 200 member-score pairs

diff --git a/java/client/src/main/java/glide/api/models/BaseTransaction.java b/java/client/src/main/java/glide/api/models/BaseTransaction.java
@@ -5176,7 +5176,9 @@ public T sscan(@NonNull String key, long cursor, @NonNull SScanOptions sscanOpti
      *     always the <code>
      *     cursor</code> for the next iteration of results. <code>0</code> will be the <code>cursor
      *     </code> returned on the last iteration of the set. The second element is always an <code>
-     *     Array</code> of the subset of the set held in <code>key</code>.
+     *     Array</code> of the subset of the set held in <code>key</code>. The array in the second
+     *     element is always a flattened series of String pairs, where the value is at even indices
+     *     and the score is at odd indices.
      */
     public T zscan(@NonNull String key, long cursor) {
         protobufTransaction.addCommands(buildCommand(ZScan, buildArgs(key, Long.toString(cursor))));
@@ -5194,7 +5196,9 @@ public T zscan(@NonNull String key, long cursor) {
      *     always the <code>
      *     cursor</code> for the next iteration of results. <code>0</code> will be the <code>cursor
      *     </code> returned on the last iteration of the set. The second element is always an <code>
-     *     Array</code> of the subset of the set held in <code>key</code>.
+     *     Array</code> of the subset of the set held in <code>key</code>. The array in the second
+     *     element is always a flattened series of String pairs, where the value is at even indices
+     *     and the score is at odd indices.
      */
     public T zscan(@NonNull String key, long cursor, @NonNull ZScanOptions zScanOptions) {
         ArgsArray commandArgs =