Don't remove leading and trailing parentheses for closure types in type signature disambiguation #1231
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.
Bug/issue #, if applicable: rdar://151311221
Summary
This fixes an issue where DocC would remove leading and trailing parentheses from certain closure types that return an empty tuple in Swift (as opposed to
Void
). This resulted in unexpected disambiguation suggestions that didn't actually work when applied to the ambiguous link.Dependencies
None.
Testing
Define some overloads where one of the parameters is a closure that returns
()
. For example:Write an ambiguous link to these overloads:
The suggestions for what disambiguation to add to should suggest
-((Bool)->())
instead of-(Bool)->()
to indicate that this is a single closure parameter and not aBool
parameter and a separateVoid
return value (in this example the function doesn't returnVoid
/()
).Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded[ ] Updated documentation if necessary