From 17a7a992a47d310f6abc1c2e2752e94f2febea5d Mon Sep 17 00:00:00 2001 From: Martin Tomka Date: Tue, 18 Jul 2023 11:23:09 +0200 Subject: [PATCH 1/2] Update docs. --- ...edCircuitBreakerStrategyOptions.TResult.cs | 18 ++++---- .../CircuitBreakerStrategyOptions.cs | 33 +++++---------- ...leCircuitBreakerStrategyOptions.TResult.cs | 6 +-- .../FallbackStrategyOptions.TResult.cs | 19 ++++----- .../Hedging/HedgingStrategyOptions.TResult.cs | 34 ++++++++------- src/Polly.Core/PredicateBuilder.TResult.cs | 2 +- .../ResilienceStrategyRegistryOptions.cs | 30 ++++++------- src/Polly.Core/ResilienceContext.cs | 4 +- .../ResilienceStrategyBuilderBase.cs | 26 +++++++++--- src/Polly.Core/ResilienceStrategyOptions.cs | 3 +- .../Retry/RetryStrategyOptions.TResult.cs | 42 ++++++++----------- .../Timeout/TimeoutStrategyOptions.cs | 18 ++++---- .../Telemetry/TelemetryOptions.cs | 26 ++++++------ .../RateLimiterStrategyOptions.cs | 12 +++--- 14 files changed, 134 insertions(+), 139 deletions(-) diff --git a/src/Polly.Core/CircuitBreaker/AdvancedCircuitBreakerStrategyOptions.TResult.cs b/src/Polly.Core/CircuitBreaker/AdvancedCircuitBreakerStrategyOptions.TResult.cs index c64cd363cf9..93ecd2b0c13 100644 --- a/src/Polly.Core/CircuitBreaker/AdvancedCircuitBreakerStrategyOptions.TResult.cs +++ b/src/Polly.Core/CircuitBreaker/AdvancedCircuitBreakerStrategyOptions.TResult.cs @@ -27,11 +27,8 @@ public class AdvancedCircuitBreakerStrategyOptions : CircuitBreakerStra /// /// /// A number between zero and one (inclusive) e.g. 0.5 represents breaking if 50% or more of actions result in a handled failure. - /// - /// A ratio number higher than 0, up to 1. - /// Defaults to 0.1 (i.e. 10%). - /// /// + /// A ratio number higher than 0, up to 1. The default value is 0.1 (i.e. 10%). [Range(0, 1.0)] public double FailureThreshold { get; set; } = CircuitBreakerConstants.DefaultAdvancedFailureThreshold; @@ -39,19 +36,18 @@ public class AdvancedCircuitBreakerStrategyOptions : CircuitBreakerStra /// Gets or sets the minimum throughput: this many actions or more must pass through the circuit in the time-slice, /// for statistics to be considered significant and the circuit-breaker to come into action. /// - /// - /// Value must be 2 or greater. - /// Defaults to 100. - /// + /// + /// The default value is 0.1 (i.e. 10%). The value must be 2 or greater. + /// [Range(CircuitBreakerConstants.MinimumValidThroughput, int.MaxValue)] public int MinimumThroughput { get; set; } = CircuitBreakerConstants.DefaultMinimumThroughput; /// /// Gets or sets the duration of the sampling over which failure ratios are assessed. /// - /// - /// Value must be greater than 0.5 seconds. Defaults to 30 seconds. - /// + /// + /// The default value is 30 seconds. Value must be greater than 0.5 seconds. + /// [Range(typeof(TimeSpan), "00:00:00.500", "1.00:00:00")] public TimeSpan SamplingDuration { get; set; } = CircuitBreakerConstants.DefaultSamplingDuration; } diff --git a/src/Polly.Core/CircuitBreaker/CircuitBreakerStrategyOptions.cs b/src/Polly.Core/CircuitBreaker/CircuitBreakerStrategyOptions.cs index 9684bea3870..5fb5fbc1243 100644 --- a/src/Polly.Core/CircuitBreaker/CircuitBreakerStrategyOptions.cs +++ b/src/Polly.Core/CircuitBreaker/CircuitBreakerStrategyOptions.cs @@ -26,20 +26,19 @@ public abstract class CircuitBreakerStrategyOptions : ResilienceStrateg /// /// Gets or sets the duration of break the circuit will stay open before resetting. /// - /// - /// Value must be greater than 0.5 seconds. - /// Defaults to 5 seconds. - /// + /// + /// The default value is 5 seconds. Value must be greater than 0.5 seconds. + /// [Range(typeof(TimeSpan), "00:00:00.500", "1.00:00:00")] public TimeSpan BreakDuration { get; set; } = CircuitBreakerConstants.DefaultBreakDuration; /// /// Gets or sets the predicates for the circuit breaker. /// - /// - /// Defaults to a delegate that handles circuit breaker on any exception except . + /// + /// The default value is a predicate that handles circuit breaker on any exception except . /// This property is required. - /// + /// [Required] public Func, ValueTask> ShouldHandle { get; set; } = DefaultPredicates.HandleOutcome; @@ -55,10 +54,8 @@ public abstract class CircuitBreakerStrategyOptions : ResilienceStrateg /// However, the invocation order of the , , and events is always /// maintained to ensure the correct sequence of state transitions. /// - /// - /// Defaults to . - /// /// + /// The default value is . public Func, ValueTask>? OnClosed { get; set; } /// @@ -73,10 +70,8 @@ public abstract class CircuitBreakerStrategyOptions : ResilienceStrateg /// However, the invocation order of the , , and events is always /// maintained to ensure the correct sequence of state transitions. /// - /// - /// Defaults to . - /// /// + /// The default value is . public Func, ValueTask>? OnOpened { get; set; } /// @@ -91,26 +86,20 @@ public abstract class CircuitBreakerStrategyOptions : ResilienceStrateg /// However, the invocation order of the , , and events is always /// maintained to ensure the correct sequence of state transitions. /// - /// - /// Defaults to . - /// /// + /// The default value is . public Func? OnHalfOpened { get; set; } /// /// Gets or sets the manual control for the circuit breaker. /// - /// - /// Defaults to . - /// + /// The default value is . public CircuitBreakerManualControl? ManualControl { get; set; } /// /// Gets or sets the state provider for the circuit breaker. /// - /// - /// Defaults to . - /// + /// The default value is . public CircuitBreakerStateProvider? StateProvider { get; set; } } diff --git a/src/Polly.Core/CircuitBreaker/SimpleCircuitBreakerStrategyOptions.TResult.cs b/src/Polly.Core/CircuitBreaker/SimpleCircuitBreakerStrategyOptions.TResult.cs index 76b45d6cd97..2c2c0320123 100644 --- a/src/Polly.Core/CircuitBreaker/SimpleCircuitBreakerStrategyOptions.TResult.cs +++ b/src/Polly.Core/CircuitBreaker/SimpleCircuitBreakerStrategyOptions.TResult.cs @@ -23,9 +23,9 @@ public class SimpleCircuitBreakerStrategyOptions : CircuitBreakerStrate /// /// Gets or sets the number of the outcome failures handled by before opening the circuit. /// - /// - /// Must be greater than 0. Defaults to 100. - /// + /// + /// The default value is 100. Must be greater than 0. + /// [Range(1, int.MaxValue)] public int FailureThreshold { get; set; } = CircuitBreakerConstants.DefaultFailureThreshold; } diff --git a/src/Polly.Core/Fallback/FallbackStrategyOptions.TResult.cs b/src/Polly.Core/Fallback/FallbackStrategyOptions.TResult.cs index 759c6eebfaa..6487a0ed480 100644 --- a/src/Polly.Core/Fallback/FallbackStrategyOptions.TResult.cs +++ b/src/Polly.Core/Fallback/FallbackStrategyOptions.TResult.cs @@ -17,28 +17,27 @@ public class FallbackStrategyOptions : ResilienceStrategyOptions /// /// Gets or sets the outcome predicate for determining whether a fallback should be executed. /// - /// - /// Defaults to a delegate that hedges on any exception except . - /// This property is required. - /// + /// + /// The default value is a predicate that fallbacks on any exception except . This property is required. + /// [Required] public Func, ValueTask> ShouldHandle { get; set; } = DefaultPredicates.HandleOutcome; /// /// Gets or sets the fallback action to be executed when the predicate evaluates as true. /// - /// - /// This property is required. Defaults to . - /// + /// + /// The default value is . This property is required. + /// [Required] public Func, ValueTask>>? FallbackAction { get; set; } /// /// Gets or sets the outcome event instance responsible for triggering fallback events. /// - /// - /// Defaults to instance. - /// + /// + /// The default value is instance. + /// public Func, ValueTask>? OnFallback { get; set; } } diff --git a/src/Polly.Core/Hedging/HedgingStrategyOptions.TResult.cs b/src/Polly.Core/Hedging/HedgingStrategyOptions.TResult.cs index 093254cb5c4..1627e6020bb 100644 --- a/src/Polly.Core/Hedging/HedgingStrategyOptions.TResult.cs +++ b/src/Polly.Core/Hedging/HedgingStrategyOptions.TResult.cs @@ -18,45 +18,45 @@ public class HedgingStrategyOptions : ResilienceStrategyOptions /// Gets or sets the minimal time of waiting before spawning a new hedged call. /// /// - /// Defaults to 2 seconds. - /// /// You can also use to create all hedged tasks (value of ) at once /// or to force the hedging strategy to never create new task before the old one is finished. - /// /// If you want a greater control over hedging delay customization use . /// + /// + /// The default value is 2 seconds. + /// public TimeSpan HedgingDelay { get; set; } = HedgingConstants.DefaultHedgingDelay; /// /// Gets or sets the maximum hedged attempts to perform the desired task. /// /// - /// Defaults to 2. The value must be bigger or equal to 2, and lower or equal to 10. - /// /// The value defines how many concurrent hedged tasks will be triggered by the strategy. /// This includes the primary hedged task that is initially performed, and the further tasks that will /// be fetched from the provider and spawned in parallel. - /// /// + /// + /// The default value is 2. The value must be bigger or equal to 2, and lower or equal to 10. + /// [Range(HedgingConstants.MinimumHedgedAttempts, HedgingConstants.MaximumHedgedAttempts)] public int MaxHedgedAttempts { get; set; } = HedgingConstants.DefaultMaxHedgedAttempts; /// /// Gets or sets the predicate that determines whether a hedging should be performed for a given result. /// - /// - /// Defaults to a delegate that hedges on any exception except . + /// + /// The default value is a predicate that hedges on any exception except . /// This property is required. - /// + /// [Required] public Func, ValueTask> ShouldHandle { get; set; } = DefaultPredicates.HandleOutcome; /// /// Gets or sets the hedging action generator that creates hedged actions. /// - /// - /// This property is required. The default delegate executes the original callback that was passed to the hedging resilience strategy. - /// + /// + /// The default generator executes the original callback that was passed to the hedging resilience strategy. This property is required. + /// [Required] public Func, Func>>?> HedgingActionGenerator { get; set; } = args => { @@ -76,19 +76,21 @@ public class HedgingStrategyOptions : ResilienceStrategyOptions /// /// /// The takes precedence over . If specified, the is ignored. - /// Defaults to . /// + /// + /// The default value is . + /// public Func>? HedgingDelayGenerator { get; set; } /// /// Gets or sets the event that is raised when a hedging is performed. /// /// - /// Defaults to . - /// /// The hedging is executed when the current attempt outcome is not successful and the predicate returns or when /// the current attempt did not finish within the . - /// /// + /// + /// The default value is . + /// public Func, ValueTask>? OnHedging { get; set; } } diff --git a/src/Polly.Core/PredicateBuilder.TResult.cs b/src/Polly.Core/PredicateBuilder.TResult.cs index 02e2750b29c..11917ed1afb 100644 --- a/src/Polly.Core/PredicateBuilder.TResult.cs +++ b/src/Polly.Core/PredicateBuilder.TResult.cs @@ -72,7 +72,7 @@ public PredicateBuilder HandleResult(Func predicate) /// Adds a predicate for handling results with a specific value. /// /// The result value to handle. - /// The comparer to use for comparing results. If null, the default comparer is used. + /// The comparer to use for comparing results. If , the default comparer is used. /// The same instance of the for chaining. public PredicateBuilder HandleResult(TResult result, IEqualityComparer? comparer = null) { diff --git a/src/Polly.Core/Registry/ResilienceStrategyRegistryOptions.cs b/src/Polly.Core/Registry/ResilienceStrategyRegistryOptions.cs index de3d0877cc2..bdc4be5553d 100644 --- a/src/Polly.Core/Registry/ResilienceStrategyRegistryOptions.cs +++ b/src/Polly.Core/Registry/ResilienceStrategyRegistryOptions.cs @@ -11,27 +11,27 @@ public class ResilienceStrategyRegistryOptions /// /// Gets or sets the factory method that creates instances of . /// - /// - /// By default, the factory method creates a new instance of using the default constructor. - /// + /// + /// The default value is a function that creates a new instance of using the default constructor. + /// [Required] public Func BuilderFactory { get; set; } = static () => new ResilienceStrategyBuilder(); /// /// Gets or sets the comparer that is used by the registry to retrieve the resilience strategies. /// - /// - /// By default, the comparer uses the default equality comparer for . - /// + /// + /// The default value is . + /// [Required] public IEqualityComparer StrategyComparer { get; set; } = EqualityComparer.Default; /// /// Gets or sets the comparer that is used by the registry to retrieve the resilience strategy builders. /// - /// - /// By default, the comparer uses the default equality comparer for . - /// + /// + /// The default value is . + /// [Required] public IEqualityComparer BuilderComparer { get; set; } = EqualityComparer.Default; @@ -40,12 +40,12 @@ public class ResilienceStrategyRegistryOptions /// represents the instance name of the builder. /// /// - /// Defaults to . - /// /// Use custom formatter for composite keys in case you want to have different metric values for a builder and instance key. /// In general, strategies can have the same builder name and different instance names. - /// /// + /// + /// The default value is . + /// public Func? InstanceNameFormatter { get; set; } /// @@ -53,12 +53,12 @@ public class ResilienceStrategyRegistryOptions /// represents the builder name. /// /// - /// By default, the formatter uses the method. - /// /// Use custom formatter for composite keys in case you want to have different metric values for a builder and strategy key. /// In general, strategies can have the same builder name and different strategy keys. - /// /// + /// + /// The default value is a formatter that formats the keys using the method. + /// [Required] public Func BuilderNameFormatter { get; set; } = (key) => key?.ToString() ?? string.Empty; } diff --git a/src/Polly.Core/ResilienceContext.cs b/src/Polly.Core/ResilienceContext.cs index fa264680230..cc1885ee7b0 100644 --- a/src/Polly.Core/ResilienceContext.cs +++ b/src/Polly.Core/ResilienceContext.cs @@ -32,10 +32,8 @@ private ResilienceContext() /// Resilience strategy instances are commonly reused across multiple call sites. /// Set an so that logging and metrics can distinguish usages of policy instances at different call sites. /// The operation key value should have a low cardinality (i.e. do not assign values such as to this property). - /// - /// Defaults to . - /// /// + /// The default value is . public string? OperationKey { get; private set; } /// diff --git a/src/Polly.Core/ResilienceStrategyBuilderBase.cs b/src/Polly.Core/ResilienceStrategyBuilderBase.cs index 4aeb59ed874..2c428030d75 100644 --- a/src/Polly.Core/ResilienceStrategyBuilderBase.cs +++ b/src/Polly.Core/ResilienceStrategyBuilderBase.cs @@ -36,8 +36,10 @@ private protected ResilienceStrategyBuilderBase(ResilienceStrategyBuilderBase ot /// /// /// This property is also included in the telemetry that is produced by the individual resilience strategies. - /// Defaults to . /// + /// + /// The default value is . + /// public string? BuilderName { get; set; } /// @@ -46,13 +48,18 @@ private protected ResilienceStrategyBuilderBase(ResilienceStrategyBuilderBase ot /// /// This property is also included in the telemetry that is produced by the individual resilience strategies. /// The instance name can be used to differentiate between multiple builder instances with the same . - /// Defaults to . /// + /// + /// The default value is . + /// public string? InstanceName { get; set; } /// /// Gets the custom properties attached to builder options. /// + /// + /// The default value is the empty instance of . + /// public ResilienceProperties Properties { get; } = new(); /// @@ -61,6 +68,9 @@ private protected ResilienceStrategyBuilderBase(ResilienceStrategyBuilderBase ot /// /// This property is internal until we switch to official System.TimeProvider. /// + /// + /// The default value is . + /// [Required] internal TimeProvider TimeProvider { get; set; } = TimeProvider.System; @@ -70,6 +80,9 @@ private protected ResilienceStrategyBuilderBase(ResilienceStrategyBuilderBase ot /// /// This property is used by the telemetry infrastructure and should not be used directly by user code. /// + /// + /// The default value is . + /// [EditorBrowsable(EditorBrowsableState.Never)] public Action>? OnCreatingStrategy { get; set; } @@ -79,15 +92,18 @@ private protected ResilienceStrategyBuilderBase(ResilienceStrategyBuilderBase ot /// /// This property is used by the telemetry infrastructure and should not be used directly by user code. /// + /// + /// The default value is . + /// [EditorBrowsable(EditorBrowsableState.Never)] public DiagnosticSource? DiagnosticSource { get; set; } /// /// Gets or sets the randomizer that is used by strategies that need to generate random numbers. /// - /// - /// The default randomizer is thread safe and returns values between 0.0 and 1.0. - /// + /// + /// The default value is thread safe randomizer function that returns values between 0.0 and 1.0. + /// [EditorBrowsable(EditorBrowsableState.Never)] [Required] public Func Randomizer { get; set; } = RandomUtil.Instance.NextDouble; diff --git a/src/Polly.Core/ResilienceStrategyOptions.cs b/src/Polly.Core/ResilienceStrategyOptions.cs index d4b5a088058..dba0434dce6 100644 --- a/src/Polly.Core/ResilienceStrategyOptions.cs +++ b/src/Polly.Core/ResilienceStrategyOptions.cs @@ -9,9 +9,10 @@ public abstract class ResilienceStrategyOptions /// Gets or sets the name of the strategy. /// /// + /// This name uniquely identifies particular instance of specific strategy. /// This property is also included in the telemetry that is produced by the individual resilience strategies. - /// Defaults to . This name uniquely identifies particular instance of specific strategy. /// + /// The default value is . public string? StrategyName { get; set; } /// diff --git a/src/Polly.Core/Retry/RetryStrategyOptions.TResult.cs b/src/Polly.Core/Retry/RetryStrategyOptions.TResult.cs index c5cec288b77..f8f11db0ea4 100644 --- a/src/Polly.Core/Retry/RetryStrategyOptions.TResult.cs +++ b/src/Polly.Core/Retry/RetryStrategyOptions.TResult.cs @@ -17,9 +17,9 @@ public class RetryStrategyOptions : ResilienceStrategyOptions /// /// Gets or sets the maximum number of retries to use, in addition to the original call. /// - /// - /// Defaults to 3 retries. For infinite retries use (-1). - /// + /// + /// The default value is 3 retries. For infinite retries use (-1). + /// [Range(RetryStrategyOptions.InfiniteRetryCount, RetryConstants.MaxRetryCount)] public int RetryCount { get; set; } = RetryConstants.DefaultRetryCount; @@ -27,11 +27,11 @@ public class RetryStrategyOptions : ResilienceStrategyOptions /// Gets or sets the type of the back-off. /// /// - /// /// This property is ignored when is set. - /// - /// Defaults to . /// + /// + /// The default value is . + /// public RetryBackoffType BackoffType { get; set; } = RetryConstants.DefaultBackoffType; /// @@ -53,23 +53,20 @@ public class RetryStrategyOptions : ResilienceStrategyOptions /// Represents the constant delay between retries. /// /// - /// /// This property is ignored when is set. - /// - /// - /// Defaults to 2 seconds. - /// /// + /// + /// The default value is 2 seconds. + /// [Range(typeof(TimeSpan), "00:00:00", "1.00:00:00")] public TimeSpan BaseDelay { get; set; } = RetryConstants.DefaultBaseDelay; /// /// Gets or sets an outcome predicate that is used to register the predicates to determine if a retry should be performed. /// - /// - /// Defaults to a delegate that retries on any exception except . - /// This property is required. - /// + /// + /// The default is a delegate that retries on any exception except . This property is required. + /// [Required] public Func, ValueTask> ShouldHandle { get; set; } = DefaultPredicates.HandleOutcome; @@ -77,26 +74,23 @@ public class RetryStrategyOptions : ResilienceStrategyOptions /// Gets or sets the generator instance that is used to calculate the time between retries. /// /// - /// /// The generator has precedence over and . - /// - /// Defaults to . /// + /// + /// The default value is . + /// public Func, ValueTask>? RetryDelayGenerator { get; set; } /// /// Gets or sets an outcome event that is used to register on-retry callbacks. /// /// - /// By default, the event is empty and no callbacks are registered. - /// /// After this event, the result produced the by user-callback is discarded and disposed to prevent resource over-consumption. If /// you need to preserve the result for further processing, create the copy of the result or extract and store all necessary information /// from the result within the event. - /// - /// - /// Defaults to . - /// /// + /// + /// The default value is . + /// public Func, ValueTask>? OnRetry { get; set; } } diff --git a/src/Polly.Core/Timeout/TimeoutStrategyOptions.cs b/src/Polly.Core/Timeout/TimeoutStrategyOptions.cs index 8aa2a6058da..8a5e74113ee 100644 --- a/src/Polly.Core/Timeout/TimeoutStrategyOptions.cs +++ b/src/Polly.Core/Timeout/TimeoutStrategyOptions.cs @@ -16,9 +16,9 @@ public class TimeoutStrategyOptions : ResilienceStrategyOptions /// /// Gets or sets the default timeout. /// - /// - /// Defaults to 30 seconds. This value must be greater than 1 second and less than 24 hours. - /// + /// + /// This value must be greater than 1 second and less than 24 hours. The default value is 30 seconds. + /// [Range(typeof(TimeSpan), "00:00:01", "1.00:00:00")] public TimeSpan Timeout { get; set; } = TimeSpan.FromSeconds(30); @@ -31,17 +31,17 @@ public class TimeoutStrategyOptions : ResilienceStrategyOptions /// /// Return to disable the timeout for the given execution. /// - /// - /// Defaults to . - /// /// + /// + /// The default value is . + /// public Func>? TimeoutGenerator { get; set; } /// /// Gets or sets the timeout that's raised when timeout occurs. /// - /// - /// Defaults to . - /// + /// + /// The default value is . + /// public Func? OnTimeout { get; set; } } diff --git a/src/Polly.Extensions/Telemetry/TelemetryOptions.cs b/src/Polly.Extensions/Telemetry/TelemetryOptions.cs index a44c2abb08f..fa00cd2ee2f 100644 --- a/src/Polly.Extensions/Telemetry/TelemetryOptions.cs +++ b/src/Polly.Extensions/Telemetry/TelemetryOptions.cs @@ -14,37 +14,35 @@ public class TelemetryOptions /// /// Gets or sets the callback that is raised when is received from Polly. /// - /// - /// Defaults to . - /// + /// + /// The default value is . + /// public Action? OnTelemetryEvent { get; set; } /// /// Gets or sets the logger factory. /// - /// - /// Defaults to . - /// + /// + /// The default value is . + /// [Required] public ILoggerFactory LoggerFactory { get; set; } = NullLoggerFactory.Instance; /// /// Gets the registered resilience telemetry enrichers. /// - /// - /// Defaults to an empty collection. - /// + /// + /// The default value is an empty collection. + /// public ICollection> Enrichers { get; } = new List>(); /// /// Gets or sets the result formatter. /// - /// - /// Defaults to a formatter that returns a status code for HTTP based responses and the result as-is for all other result types. - /// + /// + /// The default value is a formatter that returns a status code for HTTP based responses and the result as-is for all other result types. /// This property is required. - /// - /// + /// [Required] public Func ResultFormatter { get; set; } = (_, result) => result switch { diff --git a/src/Polly.RateLimiting/RateLimiterStrategyOptions.cs b/src/Polly.RateLimiting/RateLimiterStrategyOptions.cs index b235287afbb..be3c0231983 100644 --- a/src/Polly.RateLimiting/RateLimiterStrategyOptions.cs +++ b/src/Polly.RateLimiting/RateLimiterStrategyOptions.cs @@ -34,17 +34,19 @@ public class RateLimiterStrategyOptions : ResilienceStrategyOptions /// /// Gets or sets an event that is raised when the execution of user-provided callback is rejected by the rate limiter. /// - /// - /// Defaults to . - /// + /// + /// The default value is . + /// public Func? OnRejected { get; set; } /// /// Gets or sets the rate limiter that the strategy uses. /// /// - /// Defaults to . If this property is , - /// then the strategy will use a created using . + /// If this property is , then the strategy will use a created using . /// + /// + /// The default value is . This property is required. + /// public ResilienceRateLimiter? RateLimiter { get; set; } } From 59476f92c17d9a3f32dba7dd85b143845821c56d Mon Sep 17 00:00:00 2001 From: Martin Tomka Date: Tue, 18 Jul 2023 16:56:39 +0200 Subject: [PATCH 2/2] PR comments --- src/Polly.Core/ResilienceStrategyBuilderBase.cs | 2 +- src/Polly.Core/ResilienceStrategyOptions.cs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Polly.Core/ResilienceStrategyBuilderBase.cs b/src/Polly.Core/ResilienceStrategyBuilderBase.cs index 2c428030d75..e4e08c064ea 100644 --- a/src/Polly.Core/ResilienceStrategyBuilderBase.cs +++ b/src/Polly.Core/ResilienceStrategyBuilderBase.cs @@ -102,7 +102,7 @@ private protected ResilienceStrategyBuilderBase(ResilienceStrategyBuilderBase ot /// Gets or sets the randomizer that is used by strategies that need to generate random numbers. /// /// - /// The default value is thread safe randomizer function that returns values between 0.0 and 1.0. + /// The default value is thread-safe randomizer that returns values between 0.0 and 1.0. /// [EditorBrowsable(EditorBrowsableState.Never)] [Required] diff --git a/src/Polly.Core/ResilienceStrategyOptions.cs b/src/Polly.Core/ResilienceStrategyOptions.cs index dba0434dce6..93638dfbc20 100644 --- a/src/Polly.Core/ResilienceStrategyOptions.cs +++ b/src/Polly.Core/ResilienceStrategyOptions.cs @@ -9,7 +9,7 @@ public abstract class ResilienceStrategyOptions /// Gets or sets the name of the strategy. /// /// - /// This name uniquely identifies particular instance of specific strategy. + /// This name uniquely identifies a particular instance of a specific strategy. /// This property is also included in the telemetry that is produced by the individual resilience strategies. /// /// The default value is .