Remove misleading statement about background threads in F# async expressions #48891
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.
Summary
Fixes the incorrect mention of threading with respect to asynchronous operations in the F# async expressions documentation.
Problem
The documentation at
docs/fsharp/language-reference/async-expressions.md
contained a misleading statement that suggested async computations are "often started on a background thread while execution continues on the current thread." This statement was incorrect and contradicted the accurate information provided elsewhere in the F# documentation.As correctly explained in
docs/fsharp/tutorials/async.md
:Changes
Removed the misleading sentence from the Remarks section of
async-expressions.md
. The documentation now correctly states that async computations run "without blocking the current computation thread" without making false claims about automatic background thread creation.The subsequent paragraph already provides accurate information about thread choices being dependent on the triggering function used (e.g.,
Async.StartImmediate
for current thread vs. other options for background threads).Impact
This change aligns the language reference documentation with the tutorial documentation and accurately represents how F# async works, preventing developers from having incorrect assumptions about thread behavior in asynchronous operations.
Closes #[issue number]
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.