Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add breaking change documentation for SYSLIB0061 #45565

Merged
merged 7 commits into from
Apr 1, 2025

Conversation

IDisposable
Copy link
Contributor

@IDisposable IDisposable commented Mar 28, 2025

Summary

Document the obsoletion of the System.Linq.Queryable.MaxBy<> and System.Linq.Queryable.MinBy<> methods accepting an IComparer<TSource> comparer.

Also fixed the rendering of the table in obsoletions-overview.md

Fixes #45535


Internal previews

📄 File 🔗 Preview link
docs/core/compatibility/core-libraries/10.0/obsolete-apis.md docs/core/compatibility/core-libraries/10.0/obsolete-apis
docs/fundamentals/syslib-diagnostics/obsoletions-overview.md docs/fundamentals/syslib-diagnostics/obsoletions-overview
docs/fundamentals/syslib-diagnostics/syslib0061.md docs/fundamentals/syslib-diagnostics/syslib0061
docs/navigate/tools-diagnostics/toc.yml docs/navigate/tools-diagnostics/toc

Document the obsoletion of  the `System.Linq.Queryable.MaxBy` and `System.Linq.Queryable.MinBy` methods accepting an `IComparer<TSource>`.
Also fixed the rendering of the table in obsoletions-overview.md
@IDisposable IDisposable requested review from CamSoper, a team and BillWagner as code owners March 28, 2025 21:40
@dotnetrepoman dotnetrepoman bot added this to the March 2025 milestone Mar 28, 2025
@dotnet-policy-service dotnet-policy-service bot added dotnet-fundamentals/svc community-contribution Indicates PR is created by someone from the .NET community. labels Mar 28, 2025
@IDisposable
Copy link
Contributor Author

First stab at doing this @CamSoper @teo-tsirpanis @eiriktsarpalis

Please let me know if I missed anything :)

@IDisposable
Copy link
Contributor Author

IDisposable commented Mar 28, 2025

I guess I need to figure out the <xref: syntax for generic methods, please hold.

@IDisposable
Copy link
Contributor Author

IDisposable commented Mar 28, 2025

Also, those preview links are asking me to login... I suspect that's not for public consumption... I presume that I lack rights on https://review.learn.microsoft.com

https://review.learn.microsoft.com/en-us/dotnet/navigate/tools-diagnostics/toc.json?branch=pr-en-us-45565

@CamSoper
Copy link
Contributor

Also, those preview links are asking me to login... I suspect that's not for public consumption... I presume that I lack rights on https://review.learn.microsoft.com/

Correct, if you don't have a microsoft.com address, it won't let you view the staging site.

I fixed your xrefs. As soon as it builds I'll approve. LMK if you're ready to merge.

@CamSoper
Copy link
Contributor

@IDisposable That last xref I overlooked has been fixed now, too.

I have an internal tool that makes it easier to look them up and get the correct syntax.

Copy link
Contributor

@CamSoper CamSoper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM, @IDisposable! Just to make sure, do these look like the right overloads? If you say we're good, I'll :shipit:

image

@IDisposable
Copy link
Contributor Author

Yep, those are the two. The tell is IComparer<TSource> comparer (the ones we are obsoleting) and NOT IComparer<TKey> comparer (the replacement/correction added).

@IDisposable
Copy link
Contributor Author

The code change has been merged dotnet/runtime#113944

@IDisposable
Copy link
Contributor Author

Fixed typo

@CamSoper CamSoper merged commit 74663ee into dotnet:main Apr 1, 2025
8 checks passed
@IDisposable IDisposable deleted the add-syslib0061 branch April 1, 2025 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution Indicates PR is created by someone from the .NET community. dotnet-fundamentals/svc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Breaking change]: Fix type of the IComparer<T> on System.Linq.Queryable MinBy and MaxBy
3 participants