Skip to content
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.

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

Fix SA1414 warning #2172

Conversation

Zombach
Copy link
Contributor

@Zombach Zombach commented Jul 3, 2024

Pull Request

The issue or feature being addressed

#1290

Details on the issue fix or feature implementation

  • Suppress SA1414 in the code or fix the warning

Confirm the following

  • I started this PR by branching from the head of the default branch
  • I have targeted the PR to merge into the default branch
  • I have included unit tests for the issue/feature
  • I have successfully run a local build

@Zombach Zombach changed the title Fix sa1414 warning Fix SA1414 warning Jul 3, 2024
Copy link

codecov bot commented Jul 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.80%. Comparing base (0c9bef1) to head (a683038).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2172   +/-   ##
=======================================
  Coverage   83.80%   83.80%           
=======================================
  Files         313      313           
  Lines        7161     7161           
  Branches     1060     1060           
=======================================
  Hits         6001     6001           
  Misses        789      789           
  Partials      371      371           
Flag Coverage Δ
linux 83.80% <ø> (ø)
macos 83.80% <ø> (ø)
windows 83.80% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -16,7 +16,7 @@ public interface IAsyncCacheProvider
/// A <see cref="Task{TResult}" /> promising as Result a tuple whose first element is a value indicating whether
/// the key was found in the cache, and whose second element is the value from the cache (null if not found).
/// </returns>
Task<(bool, object?)> TryGetAsync(string key, CancellationToken cancellationToken, bool continueOnCapturedContext);
Task<(bool CacheHit, object? Result)> TryGetAsync(string key, CancellationToken cancellationToken, bool continueOnCapturedContext);
Copy link
Member

Choose a reason for hiding this comment

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

We can't make changes like this to the public interface. This is why the build is failing, because the public API no longer matches the baseline.

For public members, the warning just has to be suppressed. Otherwise it would be a breaking change for users.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Really. I've done something stupid

Copy link
Member

Choose a reason for hiding this comment

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

As noted in my previous comment, all these changes should be reverted.

If we wanted to make them (which we don't), they would go in the Unshipped file because these members don't exist in any shipped version.

@martincostello martincostello merged commit e622a7d into App-vNext:main Jul 3, 2024
18 checks passed
@Zombach Zombach deleted the zombach/remove-warning-sa1414-names-member-declaration branch July 3, 2024 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants