Test and document the records in MA0197, MA0198 and MA0199 - #1555
Merged
Merged
Conversation
…MA0198 and MA0199
meziantou
commented
Sep 23, 2026
… is written in its base list
meziantou
commented
Sep 23, 2026
meziantou
changed the title
meziantou
marked this pull request as ready for review
September 23, 2026 14:04
This was referenced Sep 23, 2026
Closed
Closed
Open
This was referenced Sep 28, 2026
Merged
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
The compiler implements
IEquatable<T>on every record, and this interface is part of the interfaces of the record in the XML documentation. So a documentation tool that resolves<inheritdoc />on a record sees it as a source:record Sample;has one source (IEquatable<Sample>): MA0197record Sample : ITest;has two sources (ITest,IEquatable<Sample>): MA0198record Sample : IEquatable<Sample>;has one source, as the compiler merges the declared interface with the one it implements: MA0197This is the current behavior of the rules, but it was not tested nor documented, and it can look surprising (MA0199 is never reported on a record).
Changes
After the review, the change of behavior initially proposed in this PR (ignoring the synthesized
IEquatable<T>) was dropped. The PR now only:InheritdocShouldNotBeUsedOnTypesAnalyzerTests(MA0197),InheritdocShouldNotBeAmbiguousOnTypesAnalyzerTests(MA0198, including the code fix and a record declaringIEquatable<int>) andInheritdocShouldHaveSourceOnTypesAnalyzerTests(MA0199 not reported onrecordandrecord struct)No analyzer or code fix change. The
Rules.Inheritdoctests pass on roslyn5.9 and roslyn4.8 (39 tests each).