Remove .NET Framework remarks (System.Configuration)#12643
Merged
Conversation
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-configuration |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR continues the repo-wide cleanup to remove .NET Framework-specific guidance from the System.Configuration API reference XML now that .NET Framework docs have moved to dotnetfw-api-docs. The changes primarily simplify remarks, remove .NET Framework–only links and examples, and adjust wording to be more .NET-centric.
Changes:
- Removed .NET Framework–specific remarks, related-article links (notably
/dotnet/framework/...), and some legacy examples fromSystem.ConfigurationXML docs. - Updated wording to reduce .NET Framework/app-domain/CAS-specific phrasing and modernize some lists/formatting.
- Replaced several previously substantive remarks/examples with placeholders (for example,
<remarks>To be added.</remarks>).
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Configuration/UriSection.xml | Removes .NET Framework 2.0 upgrade notes and drops a .NET Framework “Network Settings Schema” related link. |
| xml/System.Configuration/SettingsSerializeAsAttribute.xml | Updates remarks wording; introduces “.NET standard” phrasing. |
| xml/System.Configuration/SettingsProvider.xml | Removes .NET Framework/CAS trust guidance and app-domain wording; reformats numbered lists. |
| xml/System.Configuration/SectionInformation.xml | Removes .NET Framework trust-level and ASP.NET-specific guidance from remarks. |
| xml/System.Configuration/SchemeSettingElementCollection.xml | Removes .NET Framework “Network Settings Schema” related link. |
| xml/System.Configuration/SchemeSettingElement.xml | Removes .NET Framework “Network Settings Schema” related links in multiple members. |
| xml/System.Configuration/RsaProtectedConfigurationProvider.xml | Replaces full remarks/examples with a “not supported” note and placeholders for member remarks. |
| xml/System.Configuration/ProtectedConfigurationProviderCollection.xml | Updates remarks wording from “.NET Framework” to “.NET”. |
| xml/System.Configuration/LocalFileSettingsProvider.xml | Updates remarks wording from “.NET Framework” to “.NET”. |
| xml/System.Configuration/IriParsingElement.xml | Removes .NET Framework upgrade notes and removes .NET Framework 2.0 compatibility phrasing. |
| xml/System.Configuration/IdnElement.xml | Removes .NET Framework upgrade notes and removes .NET Framework 2.0 compatibility phrasing. |
| xml/System.Configuration/IConfigurationSectionHandler.xml | Simplifies deprecation message to remove .NET Framework version specificity. |
| xml/System.Configuration/IApplicationSettingsProvider.xml | Updates remarks wording from “.NET Framework” to “.NET” (side-by-side execution guidance retained). |
| xml/System.Configuration/ExeConfigurationFileMap.xml | Removes related “Configuration Files” article link; adjusts remarks wording. |
| xml/System.Configuration/ConfigurationSettings.xml | Replaces detailed legacy/back-compat remarks with a placeholder. |
| xml/System.Configuration/ConfigurationSectionGroup.xml | Replaces extensive remarks/examples with a placeholder; updates targetFramework parameter text. |
| xml/System.Configuration/ConfigurationSection.xml | Removes legacy note about section handlers; updates targetFramework wording in serialization-related members. |
| xml/System.Configuration/ConfigurationProperty.xml | Updates “.NET Framework” phrasing to “.NET”; adjusts remarks wording/formatting. |
| xml/System.Configuration/ConfigurationPermissionAttribute.xml | Replaces method remarks with placeholder text. |
| xml/System.Configuration/ConfigurationPermission.xml | Removes descriptive remarks content and replaces some method remarks with placeholders. |
| xml/System.Configuration/ConfigurationManager.xml | Removes .NET Framework-specific assembly-reference/config-file remarks; refactors lists and updates Machine.config wording. |
| xml/System.Configuration/ConfigurationElement.xml | Removes large framework-era examples and reduces remarks; updates “.NET Framework” phrasing to “.NET”. |
| xml/System.Configuration/ConfigurationCollectionAttribute.xml | Updates constructor remarks to remove “.NET Framework” phrasing. |
| xml/System.Configuration/Configuration.xml | Removes .NET Framework-related article link and some framework-era remarks/examples; updates wording. |
| xml/System.Configuration/ClientSettingsSection.xml | Removes .NET Framework wording and reorders/condenses remarks. |
| xml/System.Configuration/AppSettingsSection.xml | Replaces type-level remarks/examples with a placeholder. |
| xml/System.Configuration/AppSettingsReader.xml | Replaces type-level remarks/examples with a placeholder (method-level examples remain). |
| xml/System.Configuration/ApplicationSettingsBase.xml | Removes app-domain wording from constructor remarks. |
Comments suppressed due to low confidence (1)
xml/System.Configuration/ConfigurationPermission.xml:257
- The remarks for this method were replaced with the placeholder "To be added.", which will publish as-is. Either remove the element or restore a brief remark (for example, how null is treated or what type is expected for target) if it’s still useful.
<param name="target">The object to compare to.</param>
<summary>Compares the <see cref="T:System.Configuration.ConfigurationPermission" /> object with an object implementing the <see cref="T:System.Security.IPermission" /> interface.</summary>
<returns>
<see langword="true" /> if the permission state is equal; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
gewarren
commented
May 22, 2026
gewarren
commented
May 22, 2026
gewarren
commented
May 22, 2026
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
.NET Framework API ref has moved to its own repo (https://github.com/dotnet/dotnetfw-api-docs), so we can clean up .NET Framework remarks, exceptions, and code examples out of this repo. Contributes to #12513.
Removes remarks and examples related to:
Hide whitespace changes