clarify why/when the old cursor API will fail

Author: mgravell

src/NRedisStack/Search/ISearchCommands.cs

@@ -107,7 +107,7 @@ public interface ISearchCommands
     /// <param name="cursorId">The cursor's ID.</param>
     /// <returns><see langword="true"/> if it has been deleted, <see langword="false"/> if it did not exist.</returns>
     /// <remarks><seealso href="https://redis.io/commands/ft.cursor-del/"/></remarks>
-    [Obsolete("When possible, use CursorDel(AggregationResult) instead.")]
+    [Obsolete("When possible, use CursorDel(AggregationResult) instead. This legacy API will not work correctly on CLUSTER environments, but will continue to work for single-node deployments.")]
     [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
     bool CursorDel(string indexName, long cursorId);
 
@@ -127,7 +127,7 @@ public interface ISearchCommands
     /// <param name="count">Limit the amount of returned results.</param>
     /// <returns>A AggregationResult object with the results</returns>
     /// <remarks><seealso href="https://redis.io/commands/ft.cursor-read/"/></remarks>
-    [Obsolete("When possible, use AggregateEnumerable or CursorRead(AggregationResult, int?) instead.")]
+    [Obsolete("When possible, use AggregateEnumerable or CursorRead(AggregationResult, int?) instead. This legacy API will not work correctly on CLUSTER environments, but will continue to work for single-node deployments.")]
     [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
     AggregationResult CursorRead(string indexName, long cursorId, int? count = null);
 

src/NRedisStack/Search/ISearchCommandsAsync.cs

@@ -108,7 +108,7 @@ public interface ISearchCommandsAsync
     /// <param name="cursorId">The cursor's ID.</param>
     /// <returns><see langword="true"/> if it has been deleted, <see langword="false"/> if it did not exist.</returns>
     /// <remarks><seealso href="https://redis.io/commands/ft.cursor-del/"/></remarks>
-    [Obsolete("When possible, use CursorDelAsync(AggregationResult, int?) instead.")]
+    [Obsolete("When possible, use CursorDelAsync(AggregationResult, int?) instead. This legacy API will not work correctly on CLUSTER environments, but will continue to work for single-node deployments.")]
     [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
     Task<bool> CursorDelAsync(string indexName, long cursorId);
 
@@ -128,7 +128,7 @@ public interface ISearchCommandsAsync
     /// <param name="count">Limit the amount of returned results.</param>
     /// <returns>A AggregationResult object with the results</returns>
     /// <remarks><seealso href="https://redis.io/commands/ft.cursor-read/"/></remarks>
-    [Obsolete("When possible, use AggregateAsyncEnumerable or CursorReadAsync(AggregationResult, int?) instead.")]
+    [Obsolete("When possible, use AggregateAsyncEnumerable or CursorReadAsync(AggregationResult, int?) instead. This legacy API will not work correctly on CLUSTER environments, but will continue to work for single-node deployments.")]
     [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
     Task<AggregationResult> CursorReadAsync(string indexName, long cursorId, int? count = null);
 

src/NRedisStack/Search/SearchCommands.cs

@@ -120,7 +120,7 @@ public bool Create(string indexName, Schema schema)
     }
 
     /// <inheritdoc/>
-    [Obsolete("When possible, use CursorDel(AggregationResult) instead.")]
+    [Obsolete("When possible, use CursorDel(AggregationResult) instead. This legacy API will not work correctly on CLUSTER environments, but will continue to work for single-node deployments.")]
     [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
     public bool CursorDel(string indexName, long cursorId)
     {
@@ -144,7 +144,7 @@ public bool CursorDel(AggregationResult result)
     }
 
     /// <inheritdoc/>
-    [Obsolete("When possible, use CusorReadEnumerable or CursorRead(AggregationResult, int?) instead.")]
+    [Obsolete("When possible, use CusorReadEnumerable or CursorRead(AggregationResult, int?) instead. This legacy API will not work correctly on CLUSTER environments, but will continue to work for single-node deployments.")]
     [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
     public AggregationResult CursorRead(string indexName, long cursorId, int? count = null)
     {

src/NRedisStack/Search/SearchCommandsAsync.cs

@@ -161,7 +161,7 @@ public async Task<bool> CreateAsync(string indexName, Schema schema)
     }
 
     /// <inheritdoc/>
-    [Obsolete("When possible, use CursorDelAsync(AggregationResult, int?) instead.")]
+    [Obsolete("When possible, use CursorDelAsync(AggregationResult, int?) instead. This legacy API will not work correctly on CLUSTER environments, but will continue to work for single-node deployments.")]
     [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
     public async Task<bool> CursorDelAsync(string indexName, long cursorId)
     {
@@ -185,7 +185,7 @@ public async Task<bool> CursorDelAsync(AggregationResult result)
     }
 
     /// <inheritdoc/>
-    [Obsolete("When possible, use AggregateAsyncEnumerable or CursorReadAsync(AggregationResult, int?) instead.")]
+    [Obsolete("When possible, use AggregateAsyncEnumerable or CursorReadAsync(AggregationResult, int?) instead. This legacy API will not work correctly on CLUSTER environments, but will continue to work for single-node deployments.")]
     [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)]
     public async Task<AggregationResult> CursorReadAsync(string indexName, long cursorId, int? count = null)
     {