Skip to content

Fix the Returns callout on DispatchQueue.asyncWithFuture - #3740

Merged
Lukasa merged 1 commit into
apple:mainfrom
hxperl:asyncwithfuture-returns-callout
Sep 11, 2026
Merged

Lukasa merged 1 commit into
apple:mainfrom
hxperl:asyncwithfuture-returns-callout

Conversation

@hxperl

@hxperl hxperl commented Sep 11, 2026 •

Copy link
Copy Markdown
Contributor

DispatchQueue+WithFuture.swift:30, on the public asyncWithFuture(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.

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 Lukasa added the semver/none No version bump required. label Sep 11, 2026
@Lukasa
Lukasa enabled auto-merge (squash) September 11, 2026 13:35
@Lukasa
Lukasa merged commit a8a8f22 into apple:main Sep 11, 2026
110 of 116 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

semver/none No version bump required.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants