search

dotnet / dotnet-api-docs

.NET API reference documentation (.NET 5+, .NET Core, .NET Framework)
https://docs.microsoft.com/dotnet/api/
Other
719 stars 1.56k forks source link

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

Open KalleOlaviNiemitalo opened 1 year ago

KalleOlaviNiemitalo commented 1 year ago

The summary on the ConfigurationManager Class (Microsoft.Extensions.Configuration) | Microsoft Learn page contains this:

Once IConfigurationBuilder.Build() is called, the configuration is frozen.

However, that sentence was deleted from the XML documentation comment in ConfigurationManager.cs in https://github.com/dotnet/runtime/pull/62209, 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 https://github.com/dotnet/runtime/pull/55338, 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?

dotnet-issue-labeler[bot] commented 1 year ago

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

ghost commented 1 year ago

Tagging subscribers to this area: @dotnet/area-extensions-configuration See info in area-owners.md if you want to be subscribed.

Issue Details
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?
Author: KalleOlaviNiemitalo
Assignees: -
Labels: `untriaged`, `Pri3`, `area-Extensions-Configuration`
Milestone: -
tarekgh commented 1 year ago

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

This needs to be fixed manually. Are you interested in submitting a PR for it?

CC @carlossanlop