Documentation: Fixes retry time to timespan text (#3338)

Modify retry time in seconds to timespan of parameter maxRetryWaitTimeOnThrottledRequests (Method: [WithThrottlingRetryOptions](https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.cosmos.fluent.cosmosclientbuilder.withthrottlingretryoptions?view=azure-dotnet#feedback)) Resolves Azure/azure-sdk-for-net#29567 Co-authored-by: Matias Quaranta <[email protected]>
Azure · Jul 12, 2022 · 3ec4703 · 3ec4703
1 parent 7055fb7
commit 3ec4703
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/Microsoft.Azure.Cosmos/src/Fluent/CosmosClientBuilder.cs b/Microsoft.Azure.Cosmos/src/Fluent/CosmosClientBuilder.cs
@@ -491,7 +491,7 @@ public CosmosClientBuilder AddCustomHandlers(params RequestHandler[] customHandl
         /// <summary>
         /// Sets the maximum time to wait between retry and the max number of times to retry on throttled requests.
         /// </summary>
-        /// <param name="maxRetryWaitTimeOnThrottledRequests">The maximum retry time in seconds for the Azure Cosmos DB service. Any interval that is smaller than a second will be ignored.</param>
+        /// <param name="maxRetryWaitTimeOnThrottledRequests">The maximum retry timespan for the Azure Cosmos DB service. Any interval that is smaller than a second will be ignored.</param>
         /// <param name="maxRetryAttemptsOnThrottledRequests">The number specifies the times retry requests for throttled requests.</param>
         /// <para>
         /// When a request fails due to a rate limiting error, the service sends back a response that
@@ -704,4 +704,4 @@ internal CosmosClientBuilder WithRetryWithOptions(
             return this;
         }
     }
-}
+}