[Repo Assist] Add v4.0 migration notes to README and docs#238
Merged
Conversation
- README.md: add 'Version 4.0 — BCL IAsyncEnumerable Compatibility' section explaining the type alias, zero-cost interop, and how to migrate from v3.x - docs/index.md: add v4 callout with migration link - docs/AsyncSeq.fsx: add v4 note explaining IAsyncEnumerable<'T> interop Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Author
|
✅ Pull request created: #238 |
dsyme
approved these changes
Feb 22, 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
1 participant
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.
🤖 This PR was created by Repo Assist, an automated AI assistant.
Summary
v4.0 introduced the significant breaking change of making
AsyncSeq<'T>a type alias forSystem.Collections.Generic.IAsyncEnumerable<'T>, but this wasn't reflected anywhere in the README or narrative docs. This PR adds clear, concise migration notes where users will look first.Changes
README.md: Added a "Version 4.0 — BCL IAsyncEnumerable Compatibility" section explaining the type alias, zero-cost interop withIAsyncEnumerable<'T>sources, and how to migrate from v3.x (specifically: removeofAsyncEnum/toAsyncEnumcalls; update any direct.GetEnumerator()/.MoveNext()usages to the BCLIAsyncEnumerator<'T>contract).docs/index.md: Added a v4.0 callout block linking to the README migration notes.docs/AsyncSeq.fsx: Added a v4.0 note describing theIAsyncEnumerable<'T>interop benefit (EF Core, ASP.NET Core channels,taskSeq { }etc.).Rationale
Without these notes, users upgrading from v3.x have no indication of the breaking change unless they check
RELEASE_NOTES.md. A prominent note in the README is the standard way to surface major migration requirements.Test Status
✅ All 192 tests pass (
dotnet test -c Release). Documentation-only changes; no code modified.