RCS1140 - Don't require user to document exception types if caught in same method#1524
Merged
josefpihrt merged 11 commits intodotnet:mainfrom Sep 27, 2024
Qluxzz:fix-required-to-document-caught-exceptions
Merged
RCS1140 - Don't require user to document exception types if caught in same method#1524josefpihrt merged 11 commits intodotnet:mainfrom Qluxzz:fix-required-to-document-caught-exceptions
josefpihrt merged 11 commits intodotnet:mainfrom
Qluxzz:fix-required-to-document-caught-exceptions
Conversation
Contributor
Author
|
@dotnet-policy-service agree |
josefpihrt
requested changes
Sep 22, 2024
Collaborator
josefpihrt
left a comment
There was a problem hiding this comment.
Please update changelog.
...rp/Analysis/AddExceptionToDocumentationComment/AddExceptionToDocumentationCommentAnalysis.cs
Outdated
Show resolved
Hide resolved
...rp/Analysis/AddExceptionToDocumentationComment/AddExceptionToDocumentationCommentAnalysis.cs
Outdated
Show resolved
Hide resolved
...rp/Analysis/AddExceptionToDocumentationComment/AddExceptionToDocumentationCommentAnalysis.cs
Outdated
Show resolved
Hide resolved
...rp/Analysis/AddExceptionToDocumentationComment/AddExceptionToDocumentationCommentAnalysis.cs
Outdated
Show resolved
Hide resolved
josefpihrt
requested changes
Sep 27, 2024
...rp/Analysis/AddExceptionToDocumentationComment/AddExceptionToDocumentationCommentAnalysis.cs
Outdated
Show resolved
Hide resolved
josefpihrt
previously approved these changes
Sep 27, 2024
Collaborator
josefpihrt
left a comment
There was a problem hiding this comment.
Great PR! Thanks for the contribution.
josefpihrt
approved these changes
Sep 27, 2024
This was referenced Aug 4, 2025
This was referenced Oct 11, 2025
This was referenced Dec 15, 2025
This was referenced Dec 29, 2025
This was referenced Oct 11, 2025
This was referenced Dec 15, 2025
This was referenced Dec 29, 2025
This was referenced Jan 13, 2026
This was referenced Feb 2, 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
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.
There was no tests for RCS1140 so I added one based on the documentation for the rule.
When I was testing this rule I was not expecting it to require me to document exception types thrown but caught in the same method.
An example from a unit test I created
Here the exception is caught in the method but the analyzer for RCS1140 still require it to be documented on the method.
This PR checks if the exception type thrown in the method is also caught in the same method, and then removes the requirement to document it for the method.