From 5ee34bc304f5aeb5cd7314f94f8373da29fbe41f Mon Sep 17 00:00:00 2001 From: atakavci Date: Fri, 2 Aug 2024 15:44:08 +0300 Subject: [PATCH] - fix warnings related to xml comments - apply assembly level parallelism for enterprise redis and windows tests --- .github/workflows/integration.yml | 4 ++-- src/NRedisStack/Bloom/IBloomCommands.cs | 9 +++------ src/NRedisStack/Bloom/IBloomCommandsAsync.cs | 6 ++---- src/NRedisStack/CuckooFilter/ICuckooCommands.cs | 4 ++-- src/NRedisStack/CuckooFilter/ICuckooCommandsAsync.cs | 7 +++---- src/NRedisStack/Gears/GearsCommands.cs | 4 ++-- src/NRedisStack/Gears/GearsCommandsAsync.cs | 4 ++-- src/NRedisStack/Graph/IGraphCommands.cs | 4 ++-- src/NRedisStack/Graph/IGraphCommandsAsync.cs | 4 ++-- src/NRedisStack/Search/AggregationResult.cs | 2 +- src/NRedisStack/Tdigest/ITdigestCommands.cs | 4 ++-- src/NRedisStack/Tdigest/ITdigestCommandsAsync.cs | 4 ++-- tests/Test.proj | 2 +- 13 files changed, 26 insertions(+), 32 deletions(-) diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml index de05bcc0..310d599a 100644 --- a/.github/workflows/integration.yml +++ b/.github/workflows/integration.yml @@ -59,7 +59,7 @@ jobs: run: dotnet build --no-restore /p:ContinuousIntegrationBuild=true - name: Test - run: dotnet test -f net8.0 --no-build --verbosity detailed + run: dotnet test -f net8.0 --no-build --verbosity detailed -p:BuildInParallel=false tests/Test.proj dotnet_6_cluster: name: .NET 6 on [redis-stack cluster] @@ -175,4 +175,4 @@ jobs: shell: cmd run: | START wsl ./redis-stack-server-${{env.redis_stack_version}}/bin/redis-stack-server & - dotnet test -f net481 --no-build --verbosity detailed \ No newline at end of file + dotnet test -f net481 --no-build --verbosity detailed -p:BuildInParallel=false tests/Test.proj \ No newline at end of file diff --git a/src/NRedisStack/Bloom/IBloomCommands.cs b/src/NRedisStack/Bloom/IBloomCommands.cs index 8ca224f9..763d8b67 100644 --- a/src/NRedisStack/Bloom/IBloomCommands.cs +++ b/src/NRedisStack/Bloom/IBloomCommands.cs @@ -47,12 +47,9 @@ public interface IBloomCommands /// One or more items to add. /// (Optional) Specifies the desired capacity for the filter to be created. /// (Optional) Specifies the error ratio of the newly created filter if it does not yet exist. - /// (Optional) When capacity is reached, an additional sub-filter is - /// created in size of the last sub-filter multiplied by expansion. - /// (Optional) to indicates that the - /// filter should not be created if it does not already exist. - /// (Optional) toprevent the filter - /// from creating additional sub-filters if initial capacity is reached. + /// (Optional) When capacity is reached, an additional sub-filter is created in size of the last sub-filter multiplied by expansion. + /// (Optional) to indicates that the filter should not be created if it does not already exist. + /// (Optional) toprevent the filter from creating additional sub-filters if initial capacity is reached. /// An array of booleans. Each element is either true or false depending on whether the /// corresponding input element was newly added to the filter or may have previously existed. /// diff --git a/src/NRedisStack/Bloom/IBloomCommandsAsync.cs b/src/NRedisStack/Bloom/IBloomCommandsAsync.cs index f4f278bb..5da514c6 100644 --- a/src/NRedisStack/Bloom/IBloomCommandsAsync.cs +++ b/src/NRedisStack/Bloom/IBloomCommandsAsync.cs @@ -50,10 +50,8 @@ public interface IBloomCommandsAsync /// (Optional) Specifies the error ratio of the newly created filter if it does not yet exist. /// (Optional) When capacity is reached, an additional sub-filter is /// created in size of the last sub-filter multiplied by expansion. - /// (Optional) to indicates that the - /// filter should not be created if it does not already exist. - /// (Optional) toprevent the filter - /// from creating additional sub-filters if initial capacity is reached. + /// (Optional) to indicates that the filter should not be created if it does not already exist. + /// (Optional) toprevent the filter from creating additional sub-filters if initial capacity is reached. /// An array of booleans. Each element is either true or false depending on whether the /// corresponding input element was newly added to the filter or may have previously existed. /// diff --git a/src/NRedisStack/CuckooFilter/ICuckooCommands.cs b/src/NRedisStack/CuckooFilter/ICuckooCommands.cs index 4483f1c0..1ec87b63 100644 --- a/src/NRedisStack/CuckooFilter/ICuckooCommands.cs +++ b/src/NRedisStack/CuckooFilter/ICuckooCommands.cs @@ -64,7 +64,7 @@ public interface ICuckooCommands /// The name of the filter. /// One or more items to add. /// (Optional) Specifies the desired capacity for the filter to be created. - /// (Optional) to indicates that the + /// (Optional) to indicates that the filter should not be created if it does not already exist. /// An array of booleans. /// bool[] Insert(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false); @@ -76,7 +76,7 @@ public interface ICuckooCommands /// The name of the filter. /// One or more items to add. /// (Optional) Specifies the desired capacity for the filter to be created. - /// (Optional) to indicates that the + /// (Optional) to indicates that the filter should not be created if it does not already exist. /// An array of booleans.where means the item has been added to the filter, /// and mean, the item already existed /// diff --git a/src/NRedisStack/CuckooFilter/ICuckooCommandsAsync.cs b/src/NRedisStack/CuckooFilter/ICuckooCommandsAsync.cs index 6717c02a..85225cd9 100644 --- a/src/NRedisStack/CuckooFilter/ICuckooCommandsAsync.cs +++ b/src/NRedisStack/CuckooFilter/ICuckooCommandsAsync.cs @@ -64,7 +64,7 @@ public interface ICuckooCommandsAsync /// The name of the filter. /// One or more items to add. /// (Optional) Specifies the desired capacity for the filter to be created. - /// (Optional) to indicates that the + /// (Optional) to indicates that the filter should not be created if it does not already exist. /// An array of booleans. /// Task InsertAsync(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false); @@ -76,9 +76,8 @@ public interface ICuckooCommandsAsync /// The name of the filter. /// One or more items to add. /// (Optional) Specifies the desired capacity for the filter to be created. - /// (Optional) to indicates that the - /// An array of booleans.where means the item has been added to the filter, - /// and mean, the item already existed + /// (Optional) to indicates that the filter should not be created if it does not already exist. + /// An array of booleans.where means the item has been added to the filter, and mean, the item already existed /// Task InsertNXAsync(RedisKey key, RedisValue[] items, int? capacity = null, bool nocreate = false); diff --git a/src/NRedisStack/Gears/GearsCommands.cs b/src/NRedisStack/Gears/GearsCommands.cs index 64b7eeb8..b82a1eb2 100644 --- a/src/NRedisStack/Gears/GearsCommands.cs +++ b/src/NRedisStack/Gears/GearsCommands.cs @@ -54,7 +54,7 @@ public static Dictionary[] TFunctionList(this IDatabase db, /// The function name to run. /// keys that will be touched by the function. /// Additional argument to pass to the function. - /// The return value from the sync & async function on error in case of failure. + /// The return value from the sync & async function on error in case of failure. /// public static RedisResult TFCall_(this IDatabase db, string libraryName, string functionName, string[]? keys = null, string[]? args = null) { @@ -68,7 +68,7 @@ public static RedisResult TFCall_(this IDatabase db, string libraryName, string /// The function name to run. /// keys that will be touched by the function. /// Additional argument to pass to the function. - /// The return value from the sync & async function on error in case of failure. + /// The return value from the sync & async function on error in case of failure. /// public static RedisResult TFCallAsync_(this IDatabase db, string libraryName, string functionName, string[]? keys = null, string[]? args = null) { diff --git a/src/NRedisStack/Gears/GearsCommandsAsync.cs b/src/NRedisStack/Gears/GearsCommandsAsync.cs index 09b1fafa..076d51bc 100644 --- a/src/NRedisStack/Gears/GearsCommandsAsync.cs +++ b/src/NRedisStack/Gears/GearsCommandsAsync.cs @@ -53,7 +53,7 @@ public static async Task[]> TFunctionListAsync(t /// The function name to run. /// keys that will be touched by the function. /// Additional argument to pass to the function. - /// The return value from the sync & async function on error in case of failure. + /// The return value from the sync & async function on error in case of failure. /// public async static Task TFCall_Async(this IDatabase db, string libraryName, string functionName, string[]? keys = null, string[]? args = null) { @@ -67,7 +67,7 @@ public async static Task TFCall_Async(this IDatabase db, string lib /// The function name to run. /// keys that will be touched by the function. /// Additional argument to pass to the function. - /// The return value from the sync & async function on error in case of failure. + /// The return value from the sync & async function on error in case of failure. /// public async static Task TFCallAsync_Async(this IDatabase db, string libraryName, string functionName, string[]? keys = null, string[]? args = null) { diff --git a/src/NRedisStack/Graph/IGraphCommands.cs b/src/NRedisStack/Graph/IGraphCommands.cs index 3052cb23..afd5c73b 100644 --- a/src/NRedisStack/Graph/IGraphCommands.cs +++ b/src/NRedisStack/Graph/IGraphCommands.cs @@ -128,7 +128,7 @@ public interface IGraphCommands /// Set the value of a RedisGraph configuration parameter. /// /// The config name. - /// Dictionary of . + /// Dictionary of <string, object>. /// Dictionary ConfigGet(string configName); @@ -136,7 +136,7 @@ public interface IGraphCommands /// Returns a list containing up to 10 of the slowest queries issued against the given graph Name. /// /// The graph name. - /// Dictionary of . + /// Dictionary of <string, object>. /// List> Slowlog(string graphName); } diff --git a/src/NRedisStack/Graph/IGraphCommandsAsync.cs b/src/NRedisStack/Graph/IGraphCommandsAsync.cs index 7a178a7a..42b3de18 100644 --- a/src/NRedisStack/Graph/IGraphCommandsAsync.cs +++ b/src/NRedisStack/Graph/IGraphCommandsAsync.cs @@ -128,7 +128,7 @@ public interface IGraphCommandsAsync /// Set the value of a RedisGraph configuration parameter. /// /// The config name. - /// Dictionary of . + /// Dictionary of <string, object>. /// Task> ConfigGetAsync(string configName); @@ -136,7 +136,7 @@ public interface IGraphCommandsAsync /// Returns a list containing up to 10 of the slowest queries issued against the given graph Name. /// /// The graph name. - /// Dictionary of . + /// Dictionary of <string, object>. /// Task>> SlowlogAsync(string graphName); } diff --git a/src/NRedisStack/Search/AggregationResult.cs b/src/NRedisStack/Search/AggregationResult.cs index f9497273..f3410c29 100644 --- a/src/NRedisStack/Search/AggregationResult.cs +++ b/src/NRedisStack/Search/AggregationResult.cs @@ -42,7 +42,7 @@ internal AggregationResult(RedisResult result, long cursorId = -1) /// /// takes a Redis multi-bulk array represented by a RedisResult[] and recursively processes its elements. /// For each element in the array, it checks if it's another multi-bulk array, and if so, it recursively calls itself. - /// If the element is not a multi-bulk array, it's added directly to a List. + /// If the element is not a multi-bulk array, it's added directly to a List<object>. /// The method returns a nested list structure, reflecting the hierarchy of the original multi-bulk array, /// with each element either being a direct value or a nested list. /// diff --git a/src/NRedisStack/Tdigest/ITdigestCommands.cs b/src/NRedisStack/Tdigest/ITdigestCommands.cs index 667ab676..6607d601 100644 --- a/src/NRedisStack/Tdigest/ITdigestCommands.cs +++ b/src/NRedisStack/Tdigest/ITdigestCommands.cs @@ -16,11 +16,11 @@ public interface ITdigestCommands bool Add(RedisKey key, params double[] values); /// - /// Estimate the fraction of all observations added which are <= value. + /// Estimate the fraction of all observations added which are <= value. /// /// The name of the sketch. /// upper limit of observation value. - /// double-reply - estimation of the fraction of all observations added which are <= value + /// double-reply - estimation of the fraction of all observations added which are <= value /// double[] CDF(RedisKey key, params double[] values); diff --git a/src/NRedisStack/Tdigest/ITdigestCommandsAsync.cs b/src/NRedisStack/Tdigest/ITdigestCommandsAsync.cs index c1cf850b..7bbc22d9 100644 --- a/src/NRedisStack/Tdigest/ITdigestCommandsAsync.cs +++ b/src/NRedisStack/Tdigest/ITdigestCommandsAsync.cs @@ -14,11 +14,11 @@ public interface ITdigestCommandsAsync Task AddAsync(RedisKey key, params double[] values); /// - /// Estimate the fraction of all observations added which are <= value. + /// Estimate the fraction of all observations added which are <= value. /// /// The name of the sketch. /// upper limit of observation value. - /// double-reply - estimation of the fraction of all observations added which are <= value + /// double-reply - estimation of the fraction of all observations added which are <= value /// Task CDFAsync(RedisKey key, params double[] values); diff --git a/tests/Test.proj b/tests/Test.proj index b84232db..a17dd759 100644 --- a/tests/Test.proj +++ b/tests/Test.proj @@ -2,4 +2,4 @@ - \ No newline at end of file +