Include experimental attribute in API definition for properties #7232
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sharwell
reviewed
Mar 7, 2024
| @@ -599,7 +599,13 @@ private ApiName GetApiName(ISymbol symbol) | |||
| { | |||
| for (var current = symbol; current is not null; current = current.ContainingSymbol) | |||
| { | |||
| foreach (var attribute in current.GetAttributes()) | |||
| var attributes = current.GetAttributes(); | |||
There was a problem hiding this comment.
💡 It's possible for both the property and the method to have attributes. For example:
[Experimental("A")]
public object? Value { [NotNull] get; }
Perhaps we extract the body of the foreach to a local function, and then call for both current.GetAttributes() and (if no experimental attribute was found) also call it for the containing property if the current method is an accessor.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #7232 +/- ##
=======================================
Coverage 96.46% 96.47%
=======================================
Files 1432 1432
Lines 342185 342271 +86
Branches 11280 11283 +3
=======================================
+ Hits 330104 330190 +86
+ Misses 9230 9228 -2
- Partials 2851 2853 +2 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Affected analyzer: DeclarePublicApiAnalyzer
Affected diagnostic IDs: RS0016 and RS0051
This PR ensures the diagnostic ID of the
ExperimentalAttributeis included in the API definition for properties.Fixes #7195