Skip to content

Commit daf65ef

Browse files
committed
Add method documentation to fix linting errors.
Signed-off-by: currantw <[email protected]>
1 parent 9bbcb13 commit daf65ef

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

sources/Valkey.Glide/BaseClient.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,12 @@ private void FailureCallback(ulong index, IntPtr strPtr, RequestErrorType errTyp
155155

156156
protected abstract Task<Version> GetServerVersionAsync();
157157

158+
/// <summary>
159+
/// Executes a cluster scan command with the given cursor and arguments.
160+
/// </summary>
161+
/// <param name="cursor">The cursor for the scan iteration.</param>
162+
/// <param name="args">Additional arguments for the scan command.</param>
163+
/// <returns>A tuple containing the next cursor and the keys found in this iteration.</returns>
158164
protected async Task<(string cursor, ValkeyKey[] keys)> ClusterScanCommand(string cursor, string[] args)
159165
{
160166
var message = _messageContainer.GetMessageForCall();

sources/Valkey.Glide/GlideClusterClient.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,14 @@ protected override async Task<Version> GetServerVersionAsync()
319319
return _serverVersion;
320320
}
321321

322+
/// <summary>
323+
/// Iterates incrementally over keys in the cluster.
324+
/// </summary>
325+
/// <param name="cursor">The cursor to use for this iteration.</param>
326+
/// <param name="options">Optional scan options to filter results.</param>
327+
/// <returns>A tuple containing the next cursor and the keys found in this iteration.</returns>
328+
/// <seealso cref="ClusterScanCursor"/>
329+
/// <seealso cref="ScanOptions"/>
322330
public async Task<(ClusterScanCursor cursor, ValkeyKey[] keys)> ScanAsync(ClusterScanCursor cursor, ScanOptions? options = null)
323331
{
324332
string[] args = options?.ToArgs() ?? [];

0 commit comments

Comments
 (0)