Skip to content

Fix S3246 warning #2204

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 3 commits into from
Jul 18, 2024
Merged

Fix S3246 warning #2204

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
396438a
fix S3246 warning
Zombach Jul 17, 2024
f25e762
PR by feedback
Zombach Jul 18, 2024
5ee86cf
Merge branch 'main' into zombach/remove-warning-s3246
Zombach Jul 18, 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/Caching/ITtlStrategy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public interface ITtlStrategy : ITtlStrategy<object>
/// Defines a strategy for providing time-to-live durations for cacheable results.
/// </summary>
/// <typeparam name="TResult">The type of the result.</typeparam>
public interface ITtlStrategy<TResult>
public interface ITtlStrategy<in TResult>
{
/// <summary>
/// Gets a TTL for a cacheable item, given the current execution context.
Expand Down
2 changes: 1 addition & 1 deletion src/Polly/CircuitBreaker/ICircuitBreakerPolicy.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public interface ICircuitBreakerPolicy : IsPolicy
/// Defines properties and methods common to all circuit-breaker policies generic-typed for executions returning results of type <typeparamref name="TResult"/>.
/// </summary>
/// <typeparam name="TResult">The type of the result.</typeparam>
public interface ICircuitBreakerPolicy<TResult> : ICircuitBreakerPolicy
public interface ICircuitBreakerPolicy<out TResult> : ICircuitBreakerPolicy
Copy link
Member

@martincostello martincostello Jul 18, 2024

Choose a reason for hiding this comment

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

I'm going to have to read up on whether these changes are considered breaking or not.

Copy link
Member

@martincostello martincostello Jul 18, 2024

Choose a reason for hiding this comment

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

The third reply under this Stack Overflow answer by Eric Lippert seems to suggest it's a breaking change: https://stackoverflow.com/a/3603459

{
/// <summary>
/// Gets the last result returned from a user delegate which the circuit-breaker handled.
Expand Down
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 @@ -8,7 +8,7 @@
<MutationScore>70</MutationScore>
<IncludePollyUsings>true</IncludePollyUsings>
<NoWarn>$(NoWarn);CA1010;CA1031;CA1051;CA1062;CA1063;CA1064;CA1710;CA1716;CA1724;CA1805;CA1815;CA1816;CA2211</NoWarn>
<NoWarn>$(NoWarn);S2223;S3215;S3246;S3971;S4039;S4457</NoWarn>
<NoWarn>$(NoWarn);S2223;S3215;S3971;S4039;S4457</NoWarn>
<!--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