Remove .NET Framework remarks (System.Runtime.CompilerServices)#12666
Open
gewarren wants to merge 1 commit into
Open
Remove .NET Framework remarks (System.Runtime.CompilerServices)#12666gewarren wants to merge 1 commit into
gewarren wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR cleans up .NET Framework-specific content in the System.Runtime.CompilerServices API reference XML by removing remarks, examples, and exception text that reference legacy .NET Framework behaviors and concepts, aligning the repo with the split to dotnetfw-api-docs.
Changes:
- Removed .NET Framework-specific remarks/examples (including CER/CAS/app-domain/app.config-related text) across several
System.Runtime.CompilerServicestypes and members. - Simplified/modernized some summaries and exception descriptions by removing framework/moniker qualifiers.
- Normalized markdown/CDATA whitespace formatting in multiple remarks blocks.
Reviewed changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated 14 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Runtime.CompilerServices/StringFreezingAttribute.xml | Removes extensive remarks/examples and retains only the example block under the constructor. |
| xml/System.Runtime.CompilerServices/SpecialNameAttribute.xml | Removes .NET Framework-specific remarks and adjusts summary spacing. |
| xml/System.Runtime.CompilerServices/RuntimeHelpers.xml | Removes multiple CER/AppDomain-related remarks sections and related notes. |
| xml/System.Runtime.CompilerServices/RequiredAttributeAttribute.xml | Removes framework-version-specific notes and adjusts parameter/property remarks. |
| xml/System.Runtime.CompilerServices/MethodImplOptions.xml | Markdown/CDATA whitespace normalization in remarks. |
| xml/System.Runtime.CompilerServices/HasCopySemanticsAttribute.xml | Removes .NET Framework version note from constructor remarks. |
| xml/System.Runtime.CompilerServices/DisablePrivateReflectionAttribute.xml | Rewords note to remove explicit .NET Framework/.NET Core mentions. |
| xml/System.Runtime.CompilerServices/DebugInfoGenerator.xml | Simplifies PlatformNotSupportedException text by removing moniker qualifiers. |
| xml/System.Runtime.CompilerServices/CompilationRelaxationsAttribute.xml | Removes .NET Framework 1.0-specific remark lines in multiple remark blocks. |
| xml/System.Runtime.CompilerServices/CompilationRelaxations.xml | Removes AppDomain mention and reformats remarks; updates field summary text. |
| xml/System.Runtime.CompilerServices/AsyncVoidMethodBuilder.xml | Removes partial-trust phrasing and normalizes remarks formatting. |
| xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder`1.xml | Removes partial-trust phrasing and normalizes remarks formatting. |
| xml/System.Runtime.CompilerServices/AsyncTaskMethodBuilder.xml | Removes partial-trust phrasing, tweaks exception formatting, and normalizes remarks formatting. |
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <remarks>To be added.</remarks> |
| ]]></format> | ||
| </remarks> | ||
| <summary>Indicates that a type or member is treated in a special way by the runtime or tools. This class cannot be inherited.</summary> | ||
| <remarks>To be added.</remarks> |
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <remarks>To be added.</remarks> |
| <MemberValue>8</MemberValue> | ||
| <Docs> | ||
| <summary>Marks an assembly as not requiring string-literal interning. In an application domain, the common language runtime creates one string object for each unique string literal, rather than making multiple copies. This behavior, called <see href="https://learn.microsoft.com/dotnet/api/system.string.intern">string interning</see>, internally requires building auxiliary tables that consume memory resources.</summary> | ||
| <summary>Marks an assembly as not requiring string-literal interning. Te common language runtime creates one string object for each unique string literal, rather than making multiple copies. This behavior, called <see href="https://learn.microsoft.com/dotnet/api/system.string.intern">string interning</see>, internally requires building auxiliary tables that consume memory resources.</summary> |
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <remarks>To be added.</remarks> |
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <remarks>To be added.</remarks> |
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <remarks>To be added.</remarks> |
| ]]></format> | ||
| </remarks> | ||
| <summary>Probes for a certain amount of stack space to ensure that a stack overflow cannot happen within a subsequent block of code (assuming that your code uses only a finite and moderate amount of stack space).</summary> | ||
| <remarks>To be added.</remarks> |
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <remarks>To be added.</remarks> |
|
|
||
| ]]></format> | ||
| </remarks> | ||
| <remarks>To be added.</remarks> |
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