Skip to content

Fix S3253/S6605/SA1625/S103 warnings #2086

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
martincostello merged 19 commits into from
Apr 29, 2024
Merged

Fix S3253/S6605/SA1625/S103 warnings #2086

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
84518b8
Fix SA1618 by documenting typeparams
iamdmitrij Apr 25, 2024
f32222b
Consolidate typeparam text
iamdmitrij Apr 25, 2024
e013fa4
Enable S6605
iamdmitrij Apr 25, 2024
f21b783
Disable S3253
iamdmitrij Apr 25, 2024
ee0f007
Fix SA1625
iamdmitrij Apr 28, 2024
fb9510a
Merge branch 'App-vNext:main' into main
iamdmitrij Apr 29, 2024
ce1c4e8
Merge branch 'App-vNext:main' into main
iamdmitrij Apr 29, 2024
62ecd4a
Fix S103
iamdmitrij Apr 29, 2024
265f0ac
Merge pull request #1 from iamdmitrij/S6605
iamdmitrij Apr 29, 2024
76da73f
Merge pull request #3 from iamdmitrij/S103
iamdmitrij Apr 29, 2024
4bd777f
Merge branch 'main' into SA1625
iamdmitrij Apr 29, 2024
aad9e03
Add new line
iamdmitrij Apr 29, 2024
c4c77ee
Revert auto formatting
iamdmitrij Apr 29, 2024
f8eecf3
Revert formatted files
iamdmitrij Apr 29, 2024
7f58bec
Merge pull request #2 from iamdmitrij/SA1625
iamdmitrij Apr 29, 2024
fdb1b27
Fix ArgumentNullException doc reference to onTimeoutAsync param
iamdmitrij Apr 29, 2024
4c34715
Fix ArgumentOutOfRangeException doc reference to maxQueuingActions
iamdmitrij Apr 29, 2024
b8cd4e8
Merge branch 'main' into main
iamdmitrij Apr 29, 2024
f835153
Consolidate exception docs in AsyncTimeoutSyntax
iamdmitrij Apr 29, 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
1 change: 0 additions & 1 deletion src/Polly/Bulkhead/AsyncBulkheadSyntax.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ public static AsyncBulkheadPolicy BulkheadAsync(int maxParallelization)
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">maxParallelization;Value must be greater than zero.</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="onBulkheadRejectedAsync"/> is <see langword="null"/>.</exception>
/// <returns>The policy instance.</returns>
public static AsyncBulkheadPolicy BulkheadAsync(int maxParallelization, Func<Context, Task> onBulkheadRejectedAsync) =>
BulkheadAsync(maxParallelization, 0, onBulkheadRejectedAsync);

Expand Down
2 changes: 1 addition & 1 deletion src/Polly/Bulkhead/BulkheadSyntax.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ public static BulkheadPolicy Bulkhead(int maxParallelization, int maxQueuingActi
/// <param name="onBulkheadRejected">An action to call, if the bulkhead rejects execution due to oversubscription.</param>
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">maxParallelization;Value must be greater than zero.</exception>
/// <exception cref="ArgumentOutOfRangeException">maxParallelization;Value must be greater than zero.</exception>
/// <exception cref="ArgumentOutOfRangeException">maxParallelization;Value must be greater than or equal to zero.</exception>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="onBulkheadRejected"/> is <see langword="null"/>.</exception>
public static BulkheadPolicy Bulkhead(int maxParallelization, int maxQueuingActions, Action<Context> onBulkheadRejected)
{
Expand Down
4 changes: 2 additions & 2 deletions src/Polly/Polly.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
<NoWarn>$(NoWarn);IDE0011;S3872;SA1402;SA1414;S3215</NoWarn>
<NoWarn>$(NoWarn);IDE1006;CA1062;S107;CA1068;S4039;CA1000;CA1063;CA1031;CA1051</NoWarn>
<NoWarn>$(NoWarn);CA2211;S2223;CA1032;CA1815;CA1816;S4457;SA1615;CA1033</NoWarn>
<NoWarn>$(NoWarn);S4023;CA1010;S3442;CA1064;SA1649;SA1625;SA1623;SA1118</NoWarn>
<NoWarn>$(NoWarn);S4023;CA1010;S3442;CA1064;SA1649;SA1623;SA1118</NoWarn>
<NoWarn>$(NoWarn);S3971;CA1724;CA1716;SA1108;CA1710;S4049;S3246</NoWarn>
<NoWarn>$(NoWarn);CA1805</NoWarn>

<!--Pulic API Analyzers: We do not need to fix these as it would break compatibility with released Polly versions-->
<!--Public API Analyzers: We do not need to fix these as it would break compatibility with released Polly versions-->
<NoWarn>$(NoWarn);RS0037;</NoWarn>
</PropertyGroup>

Expand Down
4 changes: 2 additions & 2 deletions src/Polly/Timeout/AsyncTimeoutSyntax.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public static AsyncTimeoutPolicy TimeoutAsync(int seconds, Func<Context, TimeSpa
/// <remarks>The Task parameter will be null if the executed action responded cooperatively to cancellation before the policy timed it out.</remarks></param>
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">seconds;Value must be greater than zero.</exception>
/// <exception cref="ArgumentNullException">seconds;Value must be greater than zero.</exception>
/// <exception cref="ArgumentNullException">seconds;Value must not be null.</exception>
public static AsyncTimeoutPolicy TimeoutAsync(int seconds, TimeoutStrategy timeoutStrategy, Func<Context, TimeSpan, Task, Task> onTimeoutAsync)
{
TimeoutValidator.ValidateSecondsTimeout(seconds);
Expand All @@ -95,7 +95,7 @@ public static AsyncTimeoutPolicy TimeoutAsync(int seconds, TimeoutStrategy timeo
/// <remarks>The Task parameter will be null if the executed action responded cooperatively to cancellation before the policy timed it out.</remarks></param>
/// <returns>The policy instance.</returns>
/// <exception cref="ArgumentOutOfRangeException">seconds;Value must be greater than zero.</exception>
/// <exception cref="ArgumentNullException">seconds;Value must be greater than zero.</exception>
/// <exception cref="ArgumentNullException">seconds;Value must not be null.</exception>
public static AsyncTimeoutPolicy TimeoutAsync(int seconds, TimeoutStrategy timeoutStrategy, Func<Context, TimeSpan, Task, Exception, Task> onTimeoutAsync)
{
if (seconds <= 0)
Expand Down