PR comments

Author: martintmk

src/Polly.Core/CircuitBreaker/OnCircuitClosedArguments.cs

@@ -6,7 +6,7 @@ namespace Polly.CircuitBreaker;
 /// Arguments used by <see cref="CircuitBreakerStrategyOptions{TResult}.OnClosed"/> event.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct OnCircuitClosedArguments
 {

src/Polly.Core/CircuitBreaker/OnCircuitHalfOpenedArguments.cs

@@ -6,7 +6,7 @@ namespace Polly.CircuitBreaker;
 /// Arguments used by <see cref="CircuitBreakerStrategyOptions{TResult}.OnHalfOpened"/> event.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct OnCircuitHalfOpenedArguments
 {

src/Polly.Core/CircuitBreaker/OnCircuitOpenedArguments.cs

@@ -6,7 +6,7 @@ namespace Polly.CircuitBreaker;
 /// Arguments used by <see cref="CircuitBreakerStrategyOptions{TResult}.OnOpened"/> event.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct OnCircuitOpenedArguments
 {

src/Polly.Core/Fallback/OnFallbackArguments.cs

@@ -4,7 +4,7 @@ namespace Polly.Fallback;
 /// Represents arguments used in fallback handling scenarios.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct OnFallbackArguments
 {

src/Polly.Core/Hedging/OnHedgingArguments.cs

@@ -6,7 +6,7 @@ namespace Polly.Hedging;
 /// Represents arguments used by the on-hedging event.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct OnHedgingArguments
 {

src/Polly.Core/Retry/OnRetryArguments.cs

@@ -6,7 +6,7 @@ namespace Polly.Retry;
 /// Represents the arguments used by <see cref="RetryStrategyOptions{TResult}.OnRetry"/> for handling the retry event.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct OnRetryArguments
 {

src/Polly.Core/Telemetry/ExecutionAttemptArguments.cs

@@ -6,7 +6,7 @@
 /// Arguments that encapsulate the execution attempt for retries or hedging.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct ExecutionAttemptArguments
 {

src/Polly.Core/Telemetry/PipelineExecutedArguments.cs

@@ -6,7 +6,7 @@
 /// Arguments that indicate the pipeline execution started.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct PipelineExecutedArguments
 {

src/Polly.Core/Telemetry/PipelineExecutingArguments.cs

@@ -4,7 +4,7 @@
 /// Arguments that indicate the pipeline execution started.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct PipelineExecutingArguments
 {

src/Polly.Core/Telemetry/TelemetryEventArguments.cs

@@ -8,7 +8,7 @@
 /// <typeparam name="TResult">The type of result.</typeparam>
 /// <typeparam name="TArgs">The arguments associated with the resilience event.</typeparam>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct TelemetryEventArguments<TResult, TArgs>
 {

src/Polly.Core/Timeout/OnTimeoutArguments.cs

@@ -6,7 +6,7 @@ namespace Polly.Timeout;
 /// Arguments used by the timeout strategy to notify that a timeout occurred.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct OnTimeoutArguments
 {

src/Polly.Core/Timeout/TimeoutGeneratorArguments.cs

@@ -6,7 +6,7 @@ namespace Polly.Timeout;
 /// Arguments used by the timeout strategy to retrieve a timeout for current execution.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct TimeoutGeneratorArguments
 {

src/Polly.Extensions/Telemetry/EnrichmentContext.cs

@@ -9,7 +9,7 @@
 /// <typeparam name="TArgs">The type of the arguments attached to the resilience event.</typeparam>
 /// <remarks>
 /// This context is passed to enrichers in <see cref="TelemetryOptions.MeteringEnrichers"/>.
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct EnrichmentContext<TResult, TArgs>
 {

src/Polly.RateLimiting/OnRateLimiterRejectedArguments.cs

@@ -8,7 +8,7 @@ namespace Polly.RateLimiting;
 /// The arguments used by the <see cref="RateLimiterStrategyOptions.OnRejected"/>.
 /// </summary>
 /// <remarks>
-/// Always use constructor when creating this struct, otherwise we do not guarantee the binary compatibility.
+/// Always use the constructor when creating this struct, otherwise we do not guarantee binary compatibility.
 /// </remarks>
 public readonly struct OnRateLimiterRejectedArguments
 {