Remove NuGet package references from API docs#12339
Remove NuGet package references from API docs#12339jeffhandley wants to merge 2 commits intodotnet:mainfrom
Conversation
Remove self-referencing NuGet package links from all 36 files in System.Collections.Immutable, the ImmutableArrayExtensions in System.Linq, and the namespace doc. These references to the package that the APIs ship in are unnecessary. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Remove NuGet references from: - System.Configuration/ConfigurationBuilder.xml (NuGet.org package list) - System.Net.Http/HttpClientHandler.xml (NuGet package version notes) - System.Net.Http/WinHttpHandler.xml (NuGet package availability) - ns-System.Net.Http.xml (NuGet packages TIP callout) - Microsoft.Extensions.AI.Evaluation/EvaluationContext.xml (Reporting package reference) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Tagging subscribers to this area: @dotnet/area-system-collections |
|
@@jeffhandley - This PR edits one or more files whose 'source of truth' for documentation is not in this repo. Please make documentation updates in the /// comments in the dotnet/runtime repo (or dotnet/extensions repo) instead. |
There was a problem hiding this comment.
Pull request overview
This pull request removes NuGet package references from API documentation across the codebase. The changes primarily target System.Collections.Immutable APIs, which had standardized NuGet package references in summaries and remarks sections, along with a few references in System.Net.Http, System.Configuration, and Microsoft.Extensions.AI.Evaluation namespaces. The PR description indicates these references are considered out of place and inconsistent with documentation standards for other APIs.
Changes:
- Removed NuGet package references from System.Collections.Immutable API documentation (summaries and remarks)
- Removed NuGet package references from System.Net.Http namespace documentation and related types
- Removed NuGet package references from System.Configuration.ConfigurationBuilder documentation
- Simplified Microsoft.Extensions.AI.Evaluation documentation by removing a specific NuGet package mention from an example
Reviewed changes
Copilot reviewed 43 out of 43 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| xml/ns-System.Net.Http.xml | Removed TIP box about types being available through NuGet packages |
| xml/ns-System.Collections.Immutable.xml | Removed paragraph about NuGet package availability for .NET Framework |
| xml/System.Net.Http/WinHttpHandler.xml | Removed NuGet package link from remarks |
| xml/System.Net.Http/HttpClientHandler.xml | Removed version-specific NuGet package information from AutomaticDecompression property |
| xml/System.Linq/ImmutableArrayExtensions.xml | Removed NuGet package reference from summary |
| xml/System.Configuration/ConfigurationBuilder.xml | Removed list of NuGet package implementations from remarks |
| xml/System.Collections.Immutable/*.xml (29 files) | Removed standardized NuGet package references from summaries and remarks across all immutable collection types |
| xml/Microsoft.Extensions.AI.Evaluation/EvaluationContext.xml | Simplified serialization example text by removing specific NuGet package mention |
1 participant
The references to the NuGet package within the System.Collections.Immutable API docs seem out of place. These are the only APIs that have such references, and @richlander and I agreed we should propose removing them. That is commit 4a53278.
A scan across the repo found only a few other references to NuGet packages, but they seem more appropriate. We may want to keep the ones included in this commit: 2c1e1b1. If so, I'll just drop that commit and force push.