Repository navigation
Fix the Returns callout on DispatchQueue.asyncWithFuture - #3740
Merged
Merged
Conversation
The return-value line is written `- returns a new ...` with no colon, so DocC does not parse it as a Returns callout. Instead of a Return Value section the page renders a stray bullet in the Discussion. Restoring the colon also makes two stale identifiers in that sentence visible, so they are corrected in the same line: the generic parameter is `NewValue`, not `ReturnType`, and the closure parameter is `callbackMayBlock`, not `block`.
Lukasa
approved these changes
Sep 11, 2026
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.
DispatchQueue+WithFuture.swift:30, on the publicasyncWithFuture(eventLoop:_:):/// - returns a new `EventLoopFuture<ReturnType>` with value returned by the `block` parameter.No colon after
returns, so DocC does not treat it as a- Returns:callout. The method renders with no Return Value section and the sentence lands in the Discussion as a stray bullet.Added the colon.