Remove .NET Framework remarks (System.Text)#12671
Open
gewarren wants to merge 7 commits into
Open
Conversation
Contributor
|
Tagging subscribers to this area: @dotnet/area-system-text-encoding |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the ECMAXML API reference docs to remove or modernize .NET Framework-specific remarks, links, and behavioral notes, primarily within System.Text (and a couple related namespaces), now that .NET Framework API reference content lives in a separate repo.
Changes:
- Rewrites/removes .NET Framework-specific remarks, notes, and examples (including version-specific behavior callouts).
- Updates article link text from “in the .NET Framework” to “in .NET” and adjusts wording to be implementation-agnostic.
- Normalizes/cleans up some markdown formatting (tables, blank lines, notes).
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Text/UTF8Encoding.xml | Updates encoding remarks/link text and removes .NET Framework version-specific serialization note wording. |
| xml/System.Text/UTF7Encoding.xml | Updates encoding remarks/link text and removes .NET Framework version-specific serialization note wording. |
| xml/System.Text/UnicodeEncoding.xml | Cleans up markdown spacing and modernizes encoding article link text. |
| xml/System.Text/StringBuilder.xml | Removes .NET Core/.NET Framework split language in usage notes and modernizes formatting/composite-formatting wording. |
| xml/System.Text/EncodingProvider.xml | Rewords remarks to modern .NET framing and updates fallback/encoding-provider guidance. |
| xml/System.Text/EncodingInfo.xml | Updates example wording to refer to .NET rather than .NET Framework. |
| xml/System.Text/Encoding.xml | Removes .NET Framework-specific behavioral notes and simplifies/modernizes guidance around encodings and providers. |
| xml/System.Text/EncoderReplacementFallback.xml | Modernizes wording from “.NET Framework classes” to “.NET classes”. |
| xml/System.Text/EncoderFallbackBuffer.xml | Modernizes wording and updates related article title text. |
| xml/System.Text/EncoderFallback.xml | Modernizes wording and updates related article title text. |
| xml/System.Text/EncoderExceptionFallback.xml | Modernizes wording from “.NET Framework” to “.NET”. |
| xml/System.Text/DecoderReplacementFallback.xml | Modernizes wording from “.NET Framework classes” to “.NET classes”. |
| xml/System.Text/DecoderFallbackBuffer.xml | Modernizes wording and updates related article title text. |
| xml/System.Text/DecoderFallback.xml | Modernizes wording and updates related article title text. |
| xml/System.Text/DecoderExceptionFallback.xml | Modernizes wording from “.NET Framework” to “.NET”. |
| xml/System.Text/CodePagesEncodingProvider.xml | Modernizes wording and reworks guidance to avoid .NET Core-specific framing while keeping provider usage instructions. |
| xml/System.Text.RegularExpressions/Regex.xml | Updates remarks language around CompileToAssembly to remove .NET Framework-specific phrasing. |
| xml/System.Text.Json/JsonElement.xml | Removes .NET Core callouts in remarks and adjusts whitespace/formatting. |
Comment on lines
956
to
957
| The <xref:System.Text.RegularExpressions.Regex.CompileToAssembly(System.Text.RegularExpressions.RegexCompilationInfo[],System.Reflection.AssemblyName)> method generates a .NET assembly in which each regular expression defined in the `regexinfos` array is represented by a class. Typically, the <xref:System.Text.RegularExpressions.Regex.CompileToAssembly(System.Text.RegularExpressions.RegexCompilationInfo[],System.Reflection.AssemblyName)> method is called from a separate application that generates an assembly of compiled regular expressions. Each regular expression included in the assembly has the following characteristics: | ||
|
|
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
…pi-docs into fw-remarks-system-text
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:
Also removes all remarks from obsolete APIs.
Hide whitespace changes