-
-
Notifications
You must be signed in to change notification settings - Fork 258
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
RCS1140 - Don't require user to document exception types if caught in same method #1524
Merged
josefpihrt
merged 11 commits into
dotnet:main
from
Qluxzz:fix-required-to-document-caught-exceptions
Sep 27, 2024
Merged
RCS1140 - Don't require user to document exception types if caught in same method #1524
josefpihrt
merged 11 commits into
dotnet:main
from
Qluxzz:fix-required-to-document-caught-exceptions
Sep 27, 2024
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
@dotnet-policy-service agree |
josefpihrt
requested changes
Sep 22, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
Qluxzz
force-pushed
the
fix-required-to-document-caught-exceptions
branch
from
September 22, 2024 11:51
22c2600
to
7bc2b71
Compare
josefpihrt
requested changes
Sep 27, 2024
...rp/Analysis/AddExceptionToDocumentationComment/AddExceptionToDocumentationCommentAnalysis.cs
Outdated
Show resolved
Hide resolved
Qluxzz
force-pushed
the
fix-required-to-document-caught-exceptions
branch
from
September 27, 2024 10:25
b584e16
to
dc4481b
Compare
josefpihrt
previously approved these changes
Sep 27, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great PR! Thanks for the contribution.
josefpihrt
approved these changes
Sep 27, 2024
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.