Consolidate typeparam text

iamdmitrij · Apr 25, 2024 · f32222b · f32222b
1 parent 84518b8
commit f32222b
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/src/Polly/CircuitBreaker/AdvancedCircuitBreakerTResultSyntax.cs b/src/Polly/CircuitBreaker/AdvancedCircuitBreakerTResultSyntax.cs
@@ -16,7 +16,7 @@ public static class AdvancedCircuitBreakerTResultSyntax
     /// again for another <paramref name="durationOfBreak" />; if no exception or handled result is encountered, the circuit will reset.
     /// </para>
     /// </summary>
-    /// <typeparam name="TResult">The type of the result.</typeparam>
+    /// <typeparam name="TResult">The return type of delegates which may be executed through the policy.</typeparam>
     /// <param name="policyBuilder">The policy builder.</param>
     /// <param name="failureThreshold">The failure threshold at which the circuit will break (a number between 0 and 1; eg 0.5 represents breaking if 50% or more of actions result in a handled failure).</param>
     /// <param name="samplingDuration">The duration of the timeslice over which failure ratios are assessed.</param>

diff --git a/src/Polly/CircuitBreaker/AsyncAdvancedCircuitBreakerTResultSyntax.cs b/src/Polly/CircuitBreaker/AsyncAdvancedCircuitBreakerTResultSyntax.cs
@@ -87,7 +87,7 @@ public static AsyncCircuitBreakerPolicy<TResult> AdvancedCircuitBreakerAsync<TRe
     /// again for another <paramref name="durationOfBreak" />; if no exception or handled result is encountered, the circuit will reset.
     /// </para>
     /// </summary>
-    /// <typeparam name="TResult">The type of the result.</typeparam>
+    /// <typeparam name="TResult">The return type of delegates which may be executed through the policy.</typeparam>
     /// <param name="policyBuilder">The policy builder.</param>
     /// <param name="failureThreshold">The failure threshold at which the circuit will break (a number between 0 and 1; eg 0.5 represents breaking if 50% or more of actions result in a handled failure).</param>
     /// <param name="samplingDuration">The duration of the timeslice over which failure ratios are assessed.</param>

diff --git a/src/Polly/CircuitBreaker/AsyncCircuitBreakerTResultSyntax.cs b/src/Polly/CircuitBreaker/AsyncCircuitBreakerTResultSyntax.cs
@@ -113,7 +113,7 @@ public static AsyncCircuitBreakerPolicy<TResult> CircuitBreakerAsync<TResult>(th
     /// again for another <paramref name="durationOfBreak"/>; if no exception or handled result is encountered, the circuit will reset.
     /// </para>
     /// </summary>
-    /// <typeparam name="TResult">The type of the result.</typeparam>
+    /// <typeparam name="TResult">The return type of delegates which may be executed through the policy.</typeparam>
     /// <param name="policyBuilder">The policy builder.</param>
     /// <param name="handledEventsAllowedBeforeBreaking">The number of exceptions or handled results that are allowed before opening the circuit.</param>
     /// <param name="durationOfBreak">The duration the circuit will stay open before resetting.</param>