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

[C# 14] Build examples for extensions API reference #44700

Open
BillWagner opened this issue Feb 6, 2025 · 0 comments
Open

[C# 14] Build examples for extensions API reference #44700

BillWagner opened this issue Feb 6, 2025 · 0 comments
Assignees
Labels
🏁 Release: .NET 10 Work items for the .NET 10 release dotnet-csharp/svc 📌 seQUESTered Identifies that an issue has been imported into Quest.

Comments

@BillWagner
Copy link
Member

BillWagner commented Feb 6, 2025

Describe the issue or suggestion

The new extensions feature creates new requirements for API reference docs.

Build samples that demonstrate:

  • New style extension "instance" methods => Do these appear the same as existing extension methods?
  • New style extension static methods => How should they appear in API reference
  • New extension instance properties => How and where will they appear
  • New extension static properties => How and where will they appear
  • New extension operators (which are static methods) => How and where will they appear?

The API reference for IEnumerable<T> provides a template for how we document existing extension methods:

  • The page for the interface, IEnumerable<T>] has a section for Extension methods.
  • The extension methods do not appear in the TOC for the interface
  • The class containing the extension methods, System.Linq.Enumerable provides the list of all extension methods defined in that class.
  • The prototypes for those methods includes the this modifier to indicate that they extend that type.

See related issue dotnet/dotnet-api-docs#10913

More details on our first discussion can be found in this gist


Associated WorkItem - 370943

@BillWagner BillWagner self-assigned this Feb 6, 2025
@dotnet-policy-service dotnet-policy-service bot added the ⌚ Not Triaged Not triaged label Feb 6, 2025
@BillWagner BillWagner added dotnet-csharp/svc 🗺️ reQUEST Triggers an issue to be imported into Quest. 🏁 Release: .NET 10 Work items for the .NET 10 release and removed ⌚ Not Triaged Not triaged labels Feb 6, 2025
@dotnetrepoman dotnetrepoman bot added the 🗺️ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Feb 6, 2025
@dotnet-policy-service dotnet-policy-service bot removed the 🗺️ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Feb 6, 2025
@dotnetrepoman dotnetrepoman bot added the 🗺️ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Feb 6, 2025
@dotnet-policy-service dotnet-policy-service bot removed the 🗺️ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Feb 6, 2025
@dotnetrepoman dotnetrepoman bot added the 🗺️ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Feb 6, 2025
@BillWagner BillWagner moved this from 🔖 Ready to 🏗 In progress in dotnet/docs February 2025 sprint project Feb 6, 2025
@dotnet-policy-service dotnet-policy-service bot removed the 🗺️ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Feb 6, 2025
@sequestor sequestor bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Feb 7, 2025
@dotnetrepoman dotnetrepoman bot added the 🗺️ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Feb 7, 2025
@BillWagner BillWagner moved this from 🏗 In progress to 👀 In review in dotnet/docs February 2025 sprint project Feb 7, 2025
@dotnet-policy-service dotnet-policy-service bot removed the 🗺️ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. label Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏁 Release: .NET 10 Work items for the .NET 10 release dotnet-csharp/svc 📌 seQUESTered Identifies that an issue has been imported into Quest.
Projects
Status: 👀 In review
Development

No branches or pull requests

1 participant