Add MA0197 to disallow inheritdoc on types#1138
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced May 7, 2026
Closed
Closed
Closed
Merged
Closed
This was referenced Jun 9, 2026
Closed
Open
This was referenced Jun 17, 2026
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
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.
This adds a project-style rule for
<inheritdoc>usage: allow it on members, but report it on type declarations.The motivation is to enforce a members-only documentation inheritance style without changing MA0196's existing behavior.
What changed
MA0197(InheritdocShouldNotBeUsedOnTypes) and implemented a new analyzer onSymbolKind.NamedType.MA0196unchanged so it remains focused on non-inheriting members.crefcases.docs/Rules/MA0197.mdand updateddocs/comparison-with-other-analyzers.md.Notes for reviewers
<inheritdoc>guidance and stricter than SA1648 for inheriting types.MA0197reports type-level<inheritdoc>even whencrefis present, by design for this style policy.