Skip to content

Fix S3872 warning #2111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 15, 2024
Merged

Fix S3872 warning #2111

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
17936ee
Make S3872 a suggestion
iamdmitrij May 15, 2024
e249787
Introduce explicit suppressions for S3872
iamdmitrij May 15, 2024
38cffec
Fix code formatter mistake
iamdmitrij May 15, 2024
ecd9d0d
Move suppressions above summary block
iamdmitrij May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Polly/Polly.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<ProjectType>Library</ProjectType>
<MutationScore>70</MutationScore>
<IncludePollyUsings>true</IncludePollyUsings>
<NoWarn>$(NoWarn);S3872;SA1414;S3215</NoWarn>
<NoWarn>$(NoWarn);SA1414;S3215</NoWarn>
<NoWarn>$(NoWarn);IDE1006;CA1062;CA1068;S4039;CA1063;CA1031;CA1051</NoWarn>
<NoWarn>$(NoWarn);CA2211;S2223;CA1032;CA1815;CA1816;S4457;CA1033</NoWarn>
<NoWarn>$(NoWarn);CA1010;CA1064;SA1118</NoWarn>
Expand Down
12 changes: 12 additions & 0 deletions src/Polly/Timeout/TimeoutSyntax.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,9 @@ public static TimeoutPolicy Timeout(int seconds, TimeoutStrategy timeoutStrategy
/// <param name="timeout">The timeout.</param>
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be a positive TimeSpan (or Timeout.InfiniteTimeSpan to indicate no timeout).</exception>
#pragma warning disable S3872
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The build failures are annoying - I've seen them before where dotnet format doesn't complain locally but does in CI. I think to fix them you need to move the disable to above the /// comments.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, works like a charm now.

public static TimeoutPolicy Timeout(TimeSpan timeout)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);
Action<Context, TimeSpan, Task, Exception> doNothing = (_, _, _, _) => { };
Expand All @@ -124,7 +126,9 @@ public static TimeoutPolicy Timeout(TimeSpan timeout)
/// <param name="timeoutStrategy">The timeout strategy.</param>
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be a positive TimeSpan (or Timeout.InfiniteTimeSpan to indicate no timeout).</exception>
#pragma warning disable S3872
public static TimeoutPolicy Timeout(TimeSpan timeout, TimeoutStrategy timeoutStrategy)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);
Action<Context, TimeSpan, Task, Exception> doNothing = (_, _, _, _) => { };
Expand All @@ -141,7 +145,9 @@ public static TimeoutPolicy Timeout(TimeSpan timeout, TimeoutStrategy timeoutStr
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be a positive TimeSpan (or Timeout.InfiniteTimeSpan to indicate no timeout).</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="onTimeout"/> is <see langword="null"/>.</exception>
#pragma warning disable S3872
public static TimeoutPolicy Timeout(TimeSpan timeout, Action<Context, TimeSpan, Task> onTimeout)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);

Expand All @@ -157,7 +163,9 @@ public static TimeoutPolicy Timeout(TimeSpan timeout, Action<Context, TimeSpan,
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be greater than zero.</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="onTimeout"/> is <see langword="null"/>.</exception>
#pragma warning disable S3872
public static TimeoutPolicy Timeout(TimeSpan timeout, Action<Context, TimeSpan, Task, Exception> onTimeout)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);

Expand All @@ -174,7 +182,9 @@ public static TimeoutPolicy Timeout(TimeSpan timeout, Action<Context, TimeSpan,
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be a positive TimeSpan (or Timeout.InfiniteTimeSpan to indicate no timeout).</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="onTimeout"/> is <see langword="null"/>.</exception>
#pragma warning disable S3872
public static TimeoutPolicy Timeout(TimeSpan timeout, TimeoutStrategy timeoutStrategy, Action<Context, TimeSpan, Task> onTimeout)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);

Expand All @@ -191,7 +201,9 @@ public static TimeoutPolicy Timeout(TimeSpan timeout, TimeoutStrategy timeoutStr
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be greater than zero.</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="onTimeout"/> is <see langword="null"/>.</exception>
#pragma warning disable S3872
public static TimeoutPolicy Timeout(TimeSpan timeout, TimeoutStrategy timeoutStrategy, Action<Context, TimeSpan, Task, Exception> onTimeout)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);

Expand Down
12 changes: 12 additions & 0 deletions src/Polly/Timeout/TimeoutTResultSyntax.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,9 @@ public static TimeoutPolicy<TResult> Timeout<TResult>(int seconds, TimeoutStrate
/// <param name="timeout">The timeout.</param>
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be a positive TimeSpan (or Timeout.InfiniteTimeSpan to indicate no timeout).</exception>
#pragma warning disable S3872
public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);
Action<Context, TimeSpan, Task, Exception> doNothing = (_, _, _, _) => { };
Expand All @@ -131,7 +133,9 @@ public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout)
/// <param name="timeoutStrategy">The timeout strategy.</param>
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be a positive TimeSpan (or Timeout.InfiniteTimeSpan to indicate no timeout).</exception>
#pragma warning disable S3872
public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout, TimeoutStrategy timeoutStrategy)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);
Action<Context, TimeSpan, Task, Exception> doNothing = (_, _, _, _) => { };
Expand All @@ -149,7 +153,9 @@ public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout, TimeoutS
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be a positive TimeSpan (or Timeout.InfiniteTimeSpan to indicate no timeout).</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="onTimeout"/> is <see langword="null"/>.</exception>
#pragma warning disable S3872
public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout, Action<Context, TimeSpan, Task> onTimeout)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);
return Timeout<TResult>(_ => timeout, TimeoutStrategy.Optimistic, onTimeout);
Expand All @@ -165,7 +171,9 @@ public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout, Action<C
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be greater than zero.</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="onTimeout"/> is <see langword="null"/>.</exception>
#pragma warning disable S3872
public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout, Action<Context, TimeSpan, Task, Exception> onTimeout)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);
return Timeout<TResult>(_ => timeout, TimeoutStrategy.Optimistic, onTimeout);
Expand All @@ -182,7 +190,9 @@ public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout, Action<C
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be a positive TimeSpan (or Timeout.InfiniteTimeSpan to indicate no timeout).</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="onTimeout"/> is <see langword="null"/>.</exception>
#pragma warning disable S3872
public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout, TimeoutStrategy timeoutStrategy, Action<Context, TimeSpan, Task> onTimeout)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);
return Timeout<TResult>(_ => timeout, timeoutStrategy, onTimeout);
Expand All @@ -199,7 +209,9 @@ public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout, TimeoutS
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">timeout;Value must be greater than zero.</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="onTimeout"/> is <see langword="null"/>.</exception>
#pragma warning disable S3872
public static TimeoutPolicy<TResult> Timeout<TResult>(TimeSpan timeout, TimeoutStrategy timeoutStrategy, Action<Context, TimeSpan, Task, Exception> onTimeout)
#pragma warning restore S3872
{
TimeoutValidator.ValidateTimeSpanTimeout(timeout);
return Timeout<TResult>(_ => timeout, timeoutStrategy, onTimeout);
Expand Down