Skip to content

Commit 90fab68

Browse files
authored
Updates to IAsyncEnumerable breaking change (#45775)
* [Breaking change]: System.Linq.AsyncEnumerable in .NET 10 Fixes #44886 * Added xrefs, more links, some clarification * one more
1 parent 8bdb990 commit 90fab68

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/core/compatibility/core-libraries/10.0/asyncenumerable.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@ ms.custom: https://github.com/dotnet/docs/issues/44886
88

99
# System.Linq.AsyncEnumerable in .NET 10
1010

11-
.NET 10 introduces the `AsyncEnumerable` class, which provides a full set of LINQ extension methods for the <xref:System.Collections.Generic.IAsyncEnumerable`1> type. This class replaces the community-maintained `System.Linq.Async` NuGet library, potentially causing compilation errors due to ambiguities.
11+
.NET 10 introduces the <xref:System.Linq.AsyncEnumerable> class, which provides a full set of LINQ extension methods for the <xref:System.Collections.Generic.IAsyncEnumerable`1> type. This class replaces the [community-maintained `System.Linq.Async` NuGet library](https://www.nuget.org/packages/System.Linq.Async), potentially causing compilation errors due to ambiguities.
1212

1313
## Version introduced
1414

1515
.NET 10 Preview 1
1616

1717
## Previous behavior
1818

19-
The `AsyncEnumerable` class in the `System.Linq.Async` package provided LINQ support for <xref:System.Collections.Generic.IAsyncEnumerable`1>.
19+
The `AsyncEnumerable` class in the [community-maintained `System.Linq.Async` package](https://www.nuget.org/packages/System.Linq.Async) provided LINQ support for <xref:System.Collections.Generic.IAsyncEnumerable`1>.
2020

2121
## New behavior
2222

23-
The `AsyncEnumerable` class in .NET 10, as well as in the `System.Linq.AsyncEnumerable` NuGet package, provides LINQ support for <xref:System.Collections.Generic.IAsyncEnumerable`1>.
23+
The <xref:System.Linq.AsyncEnumerable> class in .NET 10, and in the [`System.Linq.AsyncEnumerable` NuGet package](https://www.nuget.org/packages/System.Linq.AsyncEnumerable/), provides LINQ support for <xref:System.Collections.Generic.IAsyncEnumerable`1>.
2424

2525
## Type of breaking change
2626

2727
This is a [source incompatible](../../categories.md#source-compatibility) change.
2828

2929
## Reason for change
3030

31-
<xref:System.Collections.Generic.IAsyncEnumerable`1> has become core enough that the platform itself should provide LINQ support for the type. Community support, including from the maintainers of `System.Linq.Async`, petitioned for this inclusion directly in the platform.
31+
<xref:System.Collections.Generic.IAsyncEnumerable`1> is a commonly used interface, so the platform itself should provide LINQ support for the type. Maintainers of `System.Linq.Async` and other community members petitioned for inclusion directly in the platform.
3232

3333
## Recommended action
3434

@@ -42,9 +42,12 @@ If `System.Linq.Async` is consumed indirectly via another package, avoid ambigui
4242
</PackageReference>
4343
```
4444

45-
Most consuming code will not need changes, but some call sites might need updates to refer to newer names and signatures.
45+
Most consuming code should be compatible without changes, but some call sites might need updates to refer to newer names and signatures.
46+
47+
Refer to the [System.Linq.AsyncEnumerable API documentation](xref:System.Linq.AsyncEnumerable) for the full set of LINQ extension methods available for <xref:System.Collections.Generic.IAsyncEnumerable`1>.
4648

4749
## Affected APIs
4850

49-
- `System.Linq.AsyncEnumerable`
50-
- <xref:System.Collections.Generic.IAsyncEnumerable`1>
51+
- <xref:System.Linq.AsyncEnumerable?displayProperty=fullName>
52+
- <xref:System.Collections.Generic.IAsyncEnumerable`1?displayProperty=fullName>
53+
- [System.Linq.Async package](https://www.nuget.org/packages/System.Linq.Async) (community-maintained)

0 commit comments

Comments
 (0)