Skip to content

Commit

Permalink
Tidy up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jduo committed Jun 29, 2024
1 parent 7eef0c1 commit f1429ac
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 40 deletions.
18 changes: 10 additions & 8 deletions java/client/src/main/java/glide/api/commands/HashBaseCommands.java
Original file line number Diff line number Diff line change
Expand Up @@ -439,13 +439,14 @@ public interface HashBaseCommands {
*
* @see <a href="https://valkey.io/commands/hscan">valkey.io</a> for details.
* @param key The key of the hash.
* @param cursor The cursor that points to the next iteration of results.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @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
* cursor</code> for the next iteration of results. <code>"0"</code> will be the <code>cursor
* </code> returned on the last iteration of the result. The second element is always an
* <code>Array</code> of the subset of the hash held in <code>key</code>. The array in the
* second element is always a flattened series of String pairs, where the key is at even
* indices and the value is at odd indices.
* second element is always a flattened series of <code>String</code> pairs, where the key is
* at even indices and the value is at odd indices.
* @example
* <pre>{@code
* // Assume key contains a set with 200 member-score pairs
Expand Down Expand Up @@ -473,14 +474,15 @@ public interface HashBaseCommands {
*
* @see <a href="https://valkey.io/commands/hscan">valkey.io</a> for details.
* @param key The key of the hash.
* @param cursor The cursor that points to the next iteration of results.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @param hScanOptions The {@link HScanOptions}.
* @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
* cursor</code> for the next iteration of results. <code>"0"</code> will be the <code>cursor
* </code> returned on the last iteration of the result. The second element is always an
* <code>Array</code> of the subset of the hash held in <code>key</code>. The array in the
* second element is always a flattened series of String pairs, where the key is at even
* indices and the value is at odd indices.
* second element is always a flattened series of <code>String</code> pairs, where the key is
* at even indices and the value is at odd indices.
* @example
* <pre>{@code
* // Assume key contains a set with 200 member-score pairs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -560,10 +560,10 @@ public interface SetBaseCommands {
*
* @see <a href="https://valkey.io/commands/sscan">valkey.io</a> for details.
* @param key The key of the set.
* @param cursor The cursor that points to the next iteration of results. A value of 0 indicates
* the start of the search.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @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
* 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>.
* @example
Expand All @@ -588,11 +588,11 @@ public interface SetBaseCommands {
*
* @see <a href="https://valkey.io/commands/sscan">valkey.io</a> for details.
* @param key The key of the set.
* @param cursor The cursor that points to the next iteration of results. A value of 0 indicates
* the start of the search.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @param sScanOptions The {@link SScanOptions}.
* @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
* 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>.
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1584,10 +1584,10 @@ CompletableFuture<Map<String, Double>> zinterWithScores(
*
* @see <a href="https://valkey.io/commands/zscan">valkey.io</a> for details.
* @param key The key of the sorted set.
* @param cursor The cursor that points to the next iteration of results. A value of 0 indicates
* the start of the search.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @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
* cursor</code> for the next iteration of results. <code>"0"</code> will be the <code>cursor
* </code> returned on the last iteration of the sorted set. The second element is always an
* <code>
* Array</code> of the subset of the sorted set held in <code>key</code>. The array in the
Expand Down Expand Up @@ -1620,11 +1620,11 @@ CompletableFuture<Map<String, Double>> zinterWithScores(
*
* @see <a href="https://valkey.io/commands/zscan">valkey.io</a> for details.
* @param key The key of the sorted set.
* @param cursor The cursor that points to the next iteration of results. A value of 0 indicates
* the start of the search.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @param zScanOptions The {@link ZScanOptions}.
* @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
* cursor</code> for the next iteration of results. <code>"0"</code> will be the <code>cursor
* </code> returned on the last iteration of the sorted set. The second element is always an
* <code>
* Array</code> of the subset of the sorted set held in <code>key</code>. The array in the
Expand Down
42 changes: 22 additions & 20 deletions java/client/src/main/java/glide/api/models/BaseTransaction.java
Original file line number Diff line number Diff line change
Expand Up @@ -5511,10 +5511,10 @@ public T geosearchstore(
*
* @see <a href="https://valkey.io/commands/sscan">valkey.io</a> for details.
* @param key The key of the set.
* @param cursor The cursor that points to the next iteration of results. A value of 0 indicates
* the start of the search.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @return Command Response - 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
* 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>.
*/
Expand All @@ -5528,11 +5528,11 @@ public T sscan(@NonNull String key, @NonNull String cursor) {
*
* @see <a href="https://valkey.io/commands/sscan">valkey.io</a> for details.
* @param key The key of the set.
* @param cursor The cursor that points to the next iteration of results. A value of 0 indicates
* the start of the search.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @param sScanOptions The {@link SScanOptions}.
* @return Command Response - 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
* 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>.
*/
Expand All @@ -5548,10 +5548,10 @@ public T sscan(@NonNull String key, @NonNull String cursor, @NonNull SScanOption
*
* @see <a href="https://valkey.io/commands/zscan">valkey.io</a> for details.
* @param key The key of the sorted set.
* @param cursor The cursor that points to the next iteration of results. A value of 0 indicates
* the start of the search.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @return Command Response - 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
* 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 sorted set. The second
* element is always an <code>Array</code> of the subset of the sorted set held in <code>key
* </code>. The array in the second element is always a flattened series of <code>String
Expand All @@ -5567,11 +5567,11 @@ public T zscan(@NonNull String key, @NonNull String cursor) {
*
* @see <a href="https://valkey.io/commands/zscan">valkey.io</a> for details.
* @param key The key of the sorted set.
* @param cursor The cursor that points to the next iteration of results. A value of 0 indicates
* the start of the search.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @param zScanOptions The {@link ZScanOptions}.
* @return Command Response - 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
* 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 sorted set. The second
* element is always an <code>Array</code> of the subset of the sorted set held in <code>key
* </code>. The array in the second element is always a flattened series of <code>String
Expand All @@ -5589,13 +5589,14 @@ public T zscan(@NonNull String key, @NonNull String cursor, @NonNull ZScanOption
*
* @see <a href="https://valkey.io/commands/hscan">valkey.io</a> for details.
* @param key The key of the hash.
* @param cursor The cursor that points to the next iteration of results.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @return Command Response - 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
* 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 result. The second element is
* always an <code>Array</code> of the subset of the hash held in <code>key</code>. The array
* in the second element is always a flattened series of String pairs, where the key is at
* even indices and the value is at odd indices.
* in the second element is always a flattened series of <code>String</code> pairs, where the
* key is at even indices and the value is at odd indices.
*/
public T hscan(@NonNull String key, @NonNull String cursor) {
protobufTransaction.addCommands(buildCommand(HScan, buildArgs(key, cursor)));
Expand All @@ -5607,14 +5608,15 @@ public T hscan(@NonNull String key, @NonNull String cursor) {
*
* @see <a href="https://valkey.io/commands/hscan">valkey.io</a> for details.
* @param key The key of the hash.
* @param cursor The cursor that points to the next iteration of results.
* @param cursor The cursor that points to the next iteration of results. A value of <code>"0"
* </code> indicates the start of the search.
* @param hScanOptions The {@link HScanOptions}.
* @return Command Response - 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
* 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 result. The second element is
* always an <code>Array</code> of the subset of the hash held in <code>key</code>. The array
* in the second element is always a flattened series of String pairs, where the key is at
* even indices and the value is at odd indices.
* in the second element is always a flattened series of <code>String</code> pairs, where the
* key is at even indices and the value is at odd indices.
*/
public T hscan(@NonNull String key, @NonNull String cursor, @NonNull HScanOptions hScanOptions) {
final ArgsArray commandArgs =
Expand Down

0 comments on commit f1429ac

Please sign in to comment.