dotnet / dotnet/dotnet-api-docs

Microsoft.Extensions.Configuration.ConfigurationManager summary is out of date wrt XML doc comment

Open
#9,380 3 comments 0 reactions 0 assignees View on GitHub
area-Extensions-Configuration Pri3
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

The summary on the [ConfigurationManager Class (Microsoft.Extensions.Configuration) | Microsoft Learn](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.configuration.configurationmanager?view=dotnet-plat-ext-7.0) page contains this:

> Once [IConfigurationBuilder.Build()](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.configuration.configurationmanager.microsoft-extensions-configuration-iconfigurationbuilder-build?view=dotnet-plat-ext-7.0#microsoft-extensions-configuration-configurationmanager-microsoft-extensions-configuration-iconfigurationbuilder-build) is called, the configuration is frozen.

However, that sentence was deleted from the XML documentation comment in ConfigurationManager.cs in , before the .NET 7.0.0 release. As far as I can tell, the sentence has never been true; when ConfigurationManager was first added in , the implementation already had `IConfigurationRoot IConfigurationBuilder.Build() => this;`, which does not freeze anything.

Is `xml/Microsoft.Extensions.Configuration/ConfigurationManager.xml` maintained manually, or is some automated process expected to import the XML doc comment changes?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.