Make ValidateDocumentationComments allow Throws doc comments for rethrows functions
#948
Conversation
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
TTOzzi
requested review from
ahoppen,
allevato,
bnbarham and
shawnhyam
as code owners
allevato
approved these changes
Feb 27, 2025
| let needsThrowsDesc = throwsOrRethrowsKeyword?.tokenKind == .keyword(.throws) | ||
|
|
||
| if !needsThrowsDesc && throwsDescription != nil { | ||
| if throwsOrRethrowsKeyword?.tokenKind == nil && throwsDescription != nil { |
There was a problem hiding this comment.
Can this just be throwsOrRethrowsKeyword == nil?
There was a problem hiding this comment.
Oh, yes. There's no need to check tokenKind. I'll fix it!
TTOzzi
force-pushed
the
allow-rethrows-docc-ValidateDocumentationComments
branch
from
b9b8e82 to
8331ba6
Compare
|
Windows failures look unrelated. I’m investigating. |
|
I saw those same flakes on Windows yesterday; they usually went away on a retry. No idea what was causing them, though. |
TTOzzi
force-pushed
the
allow-rethrows-docc-ValidateDocumentationComments
branch
from
8331ba6 to
1165ca8
Compare
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.
Resolve #928
Respecting the intent of the existing implementation, change
Throwsdocumentation forrethrowsfunctions to optional.throws→ Required; a diagnostic is triggered if missing.rethrows→ Optional; no diagnostic is triggered if missing.Throwscomment is present, a diagnostic is triggered to remove it.