Skip to content

Commit 72e5599

Browse files
authored
Improve documentation (#1487)
1 parent d72ae6c commit 72e5599

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

src/Polly.Core/CircuitBreaker/CircuitBreakerStrategyOptions.TResult.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public class CircuitBreakerStrategyOptions<TResult> : ResilienceStrategyOptions
7070
#pragma warning restore
7171

7272
/// <summary>
73-
/// Gets or sets the predicates for the circuit breaker.
73+
/// Gets or sets a predicate that determines whether the outcome should be handled by the circuit breaker.
7474
/// </summary>
7575
/// <value>
7676
/// The default value is a predicate that handles circuit breaker on any exception except <see cref="OperationCanceledException"/>.

src/Polly.Core/Fallback/FallbackStrategyOptions.TResult.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public class FallbackStrategyOptions<TResult> : ResilienceStrategyOptions
1414
public FallbackStrategyOptions() => Name = FallbackConstants.DefaultName;
1515

1616
/// <summary>
17-
/// Gets or sets the outcome predicate for determining whether a fallback should be executed.
17+
/// Gets or sets a predicate that determines whether the fallback should be executed for a given outcome.
1818
/// </summary>
1919
/// <value>
2020
/// The default value is a predicate that fallbacks on any exception except <see cref="OperationCanceledException"/>. This property is required.
@@ -32,7 +32,7 @@ public class FallbackStrategyOptions<TResult> : ResilienceStrategyOptions
3232
public Func<OutcomeArguments<TResult, FallbackPredicateArguments>, ValueTask<Outcome<TResult>>>? FallbackAction { get; set; }
3333

3434
/// <summary>
35-
/// Gets or sets the outcome event instance responsible for triggering fallback events.
35+
/// Gets or sets event delegate that is raised when fallback happens.
3636
/// </summary>
3737
/// <value>
3838
/// The default value is <see langword="null"/> instance.

src/Polly.Core/Hedging/HedgingStrategyOptions.TResult.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public class HedgingStrategyOptions<TResult> : ResilienceStrategyOptions
4141
public int MaxHedgedAttempts { get; set; } = HedgingConstants.DefaultMaxHedgedAttempts;
4242

4343
/// <summary>
44-
/// Gets or sets the predicate that determines whether a hedging should be performed for a given result.
44+
/// Gets or sets a predicate that determines whether the hedging should be executed for a given outcome.
4545
/// </summary>
4646
/// <value>
4747
/// The default value is a predicate that hedges on any exception except <see cref="OperationCanceledException"/>.
@@ -51,7 +51,7 @@ public class HedgingStrategyOptions<TResult> : ResilienceStrategyOptions
5151
public Func<OutcomeArguments<TResult, HedgingPredicateArguments>, ValueTask<bool>> ShouldHandle { get; set; } = DefaultPredicates<HedgingPredicateArguments, TResult>.HandleOutcome;
5252

5353
/// <summary>
54-
/// Gets or sets the hedging action generator that creates hedged actions.
54+
/// Gets or sets a generator that creates hedged actions.
5555
/// </summary>
5656
/// <value>
5757
/// The default generator executes the original callback that was passed to the hedging resilience strategy. This property is required.
@@ -71,7 +71,7 @@ public class HedgingStrategyOptions<TResult> : ResilienceStrategyOptions
7171
};
7272

7373
/// <summary>
74-
/// Gets or sets the generator that generates hedging delays for each hedging attempt.
74+
/// Gets or sets a generator that generates hedging delays for each hedging attempt.
7575
/// </summary>
7676
/// <remarks>
7777
/// The <see cref="HedgingDelayGenerator"/> takes precedence over <see cref="HedgingDelay"/>. If specified, the <see cref="HedgingDelay"/> is ignored.

src/Polly.Core/Retry/RetryStrategyOptions.TResult.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public class RetryStrategyOptions<TResult> : ResilienceStrategyOptions
7373
#pragma warning restore IL2026
7474

7575
/// <summary>
76-
/// Gets or sets an outcome predicate that is used to register the predicates to determine if a retry should be performed.
76+
/// Gets or sets a predicate that determines whether the retry should be executed for a given outcome.
7777
/// </summary>
7878
/// <value>
7979
/// The default is a delegate that retries on any exception except <see cref="OperationCanceledException"/>. This property is required.
@@ -82,7 +82,7 @@ public class RetryStrategyOptions<TResult> : ResilienceStrategyOptions
8282
public Func<OutcomeArguments<TResult, RetryPredicateArguments>, ValueTask<bool>> ShouldHandle { get; set; } = DefaultPredicates<RetryPredicateArguments, TResult>.HandleOutcome;
8383

8484
/// <summary>
85-
/// Gets or sets the generator instance that is used to calculate the time between retries.
85+
/// Gets or sets a generator instance that calculates the time between retries.
8686
/// </summary>
8787
/// <remarks>
8888
/// The generator has precedence over <see cref="BaseDelay"/> and <see cref="BackoffType"/>.
@@ -93,7 +93,7 @@ public class RetryStrategyOptions<TResult> : ResilienceStrategyOptions
9393
public Func<OutcomeArguments<TResult, RetryDelayArguments>, ValueTask<TimeSpan>>? RetryDelayGenerator { get; set; }
9494

9595
/// <summary>
96-
/// Gets or sets an outcome event that is used to register on-retry callbacks.
96+
/// Gets or sets an event delegate that is raised when the retry happens.
9797
/// </summary>
9898
/// <remarks>
9999
/// After this event, the result produced the by user-callback is discarded and disposed to prevent resource over-consumption. If

src/Polly.Core/Timeout/TimeoutStrategyOptions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public class TimeoutStrategyOptions : ResilienceStrategyOptions
2424
#pragma warning restore IL2026
2525

2626
/// <summary>
27-
/// Gets or sets the timeout generator that generates the timeout for a given execution.
27+
/// Gets or sets a timeout generator that generates the timeout for a given execution.
2828
/// </summary>
2929
/// <remarks>
3030
/// If generator returns a <see cref="TimeSpan"/> value that is less or equal to <see cref="TimeSpan.Zero"/>
@@ -39,7 +39,7 @@ public class TimeoutStrategyOptions : ResilienceStrategyOptions
3939
public Func<TimeoutGeneratorArguments, ValueTask<TimeSpan>>? TimeoutGenerator { get; set; }
4040

4141
/// <summary>
42-
/// Gets or sets the timeout that's raised when timeout occurs.
42+
/// Gets or sets the timeout delegate that raised when timeout occurs.
4343
/// </summary>
4444
/// <value>
4545
/// The default value is <see langword="null"/>.

src/Polly.RateLimiting/RateLimiterStrategyOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public class RateLimiterStrategyOptions : ResilienceStrategyOptions
3939
public Func<OnRateLimiterRejectedArguments, ValueTask>? OnRejected { get; set; }
4040

4141
/// <summary>
42-
/// Gets or sets the rate limiter that the strategy uses.
42+
/// Gets or sets a rate limiter used by the strategy.
4343
/// </summary>
4444
/// <value>
4545
/// The default value is <see langword="null"/>. If this property is <see langword="null"/>, then the strategy

0 commit comments

Comments
 (0)