Don't require a returns comment for functions that never return. #225
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
It's possible for someone to use a typealias for `Never`, instead of directly using `Never`, but that would be very strange and isn't supported. Any function whose return type is `Never` is ignored when validating returns comments: there won't be a warning to add a comment nor a warning to remove an existing comment. It might be useful to document the fact that the function doesn't return, or that might be trivial and not worth documenting.
allevato
approved these changes
Aug 25, 2020
allevato
added a commit
to allevato/swift-format
that referenced
this pull request
Sep 17, 2020
Don't require a returns comment for functions that never return.
allevato
added a commit
that referenced
this pull request
Sep 17, 2020
Don't require a returns comment for functions that never return.
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.
Any function whose return type is
Neveris ignored when validating returns comments: there won't be a warning to add a comment nor a warning to remove an existing comment. It might be useful to document the fact that the function doesn't return, or that might be trivial and not worth documenting.It's possible for someone to use a typealias for
Never, instead of directly usingNever, but that would be very strange and isn't supported.