Reinstate supplemental remarks (System.R*)#12707
Open
gewarren wants to merge 6 commits into
Open
Conversation
github-actions
Bot
added
the
area-Meta
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reinstates “supplemental remarks” content by replacing external “Supplemental API remarks” links with in-repo markdown remarks in several ECMA XML files, and adds/updates snippet projects to support the expanded documentation (per #12613).
Changes:
- Replaced “Supplemental API remarks” link-only
<remarks>with full markdown remark content for severalSystem.ResourcesandSystem.Reflection.*APIs. - Added/updated snippet projects and source files (C# + Visual Basic) referenced from the reinstated remarks.
- Updated Reflection Emit docs to mention persisted dynamic assemblies and related concepts.
Reviewed changes
Copilot reviewed 60 out of 60 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Resources/SatelliteContractVersionAttribute.xml | Replaces supplemental-remarks link with inlined markdown remarks. |
| xml/System.Resources/ResourceReader.xml | Replaces supplemental-remarks link with inlined markdown remarks and snippet references. |
| xml/System.Resources/ResourceManager.xml | Replaces supplemental-remarks links with large inlined markdown remarks (type + member remarks). |
| xml/System.Resources/NeutralResourcesLanguageAttribute.xml | Replaces supplemental-remarks link with inlined markdown remarks and examples. |
| xml/System.Resources/MissingManifestResourceException.xml | Replaces supplemental-remarks link with inlined markdown remarks and snippet references. |
| xml/System.Reflection.PortableExecutable/DebugDirectoryEntryType.xml | Replaces supplemental-remarks link with inlined markdown remarks and spec links. |
| xml/System.Reflection.Emit/TypeBuilder.xml | Replaces supplemental-remarks link with inlined markdown remarks. |
| xml/System.Reflection.Emit/PersistedAssemblyBuilder.xml | Replaces link-only remarks with detailed persisted Reflection Emit guidance and snippet references. |
| xml/System.Reflection.Emit/MethodBuilder.xml | Replaces supplemental-remarks link with inlined markdown remarks. |
| xml/System.Reflection.Emit/DynamicMethod.xml | Replaces supplemental-remarks link with inlined markdown remarks. |
| xml/System.Reflection.Emit/AssemblyBuilder.xml | Replaces link-only remarks with updated runnable/persisted assembly content. |
| snippets/visualbasic/System.Resources/ResourceReader/Overview/Project.vbproj | Adds VB snippet project for ResourceReader overview snippets. |
| snippets/visualbasic/System.Resources/ResourceReader/Overview/ctor1.vb | Adds VB ctor snippets for standalone/embedded ResourceReader usage. |
| snippets/visualbasic/System.Resources/ResourceReader/Overview/class1.vb | Adds VB enumeration snippet for ResourceReader. |
| snippets/visualbasic/System.Resources/ResourceManager/Overview/showtime.vb | Adds VB example used by ResourceManager overview remarks. |
| snippets/visualbasic/System.Resources/ResourceManager/Overview/showdate.vb | Adds VB culture-switching example used by ResourceManager remarks. |
| snippets/visualbasic/System.Resources/ResourceManager/Overview/rmc.vb | Adds VB satellite-assembly example used by ResourceManager remarks. |
| snippets/visualbasic/System.Resources/ResourceManager/Overview/resourcenames.vb | Adds VB utility snippet for enumerating embedded resource names. |
| snippets/visualbasic/System.Resources/ResourceManager/Overview/Project.vbproj | Adds VB snippet project for ResourceManager overview examples. |
| snippets/visualbasic/System.Resources/ResourceManager/Overview/ctor1.vb | Adds VB constructor snippets for ResourceManager instantiation patterns. |
| snippets/visualbasic/System.Resources/ResourceManager/GetString/showdate2.vb | Adds VB GetString overload example snippet. |
| snippets/visualbasic/System.Resources/ResourceManager/GetString/showdate.vb | Adds VB GetString example snippet. |
| snippets/visualbasic/System.Resources/ResourceManager/GetString/Project.vbproj | Adds VB snippet project for ResourceManager.GetString examples. |
| snippets/visualbasic/System.Resources/ResourceManager/GetObject/shownumbers.vb | Adds VB GetObject example snippet. |
| snippets/visualbasic/System.Resources/ResourceManager/GetObject/Project.vbproj | Adds VB snippet project for ResourceManager.GetObject examples. |
| snippets/visualbasic/System.Resources/ResourceManager/GetObject/numberinfo.vb | Adds VB serializable type snippet for GetObject example set. |
| snippets/visualbasic/System.Resources/ResourceManager/GetObject/example2.vb | Adds VB console output example snippet for GetObject scenario. |
| snippets/visualbasic/System.Resources/ResourceManager/GetObject/example.vb | Adds VB resource-creation + structure snippets referenced by GetObject remarks. |
| snippets/visualbasic/System.Resources/ResourceManager/GetObject/createresources.vb | Adds VB resource generation snippet for GetObject examples. |
| snippets/visualbasic/System.Resources/ResourceManager/.ctor/Project.vbproj | Adds VB snippet project for ResourceManager constructor docs. |
| snippets/visualbasic/System.Resources/ResourceManager/.ctor/greet.vb | Adds VB example snippet referenced by ctor remarks. |
| snippets/visualbasic/System.Resources/ResourceManager/.ctor/example.vb | Adds VB example snippet referenced by ctor remarks. |
| snippets/visualbasic/System.Resources/NeutralResourcesLanguageAttribute/Overview/Project.vbproj | Adds VB snippet project for NeutralResourcesLanguageAttribute examples. |
| snippets/visualbasic/System.Resources/NeutralResourcesLanguageAttribute/Overview/example.vb | Adds VB example snippet for NeutralResourcesLanguageAttribute. |
| snippets/visualbasic/System.Resources/MissingManifestResourceException/Overview/resourcenames.vb | Adds VB utility snippet for MissingManifestResourceException docs. |
| snippets/visualbasic/System.Resources/MissingManifestResourceException/Overview/Project.vbproj | Adds VB snippet project for MissingManifestResourceException examples. |
| snippets/visualbasic/System.Resources/CurrentCulture/Overview/Project.vbproj | Adds VB snippet project for culture example referenced from ResourceManager docs. |
| snippets/visualbasic/System.Resources/CurrentCulture/Overview/example.vb | Adds VB example snippet for culture switching. |
| snippets/csharp/System.Resources/ResourceManager/Overview/rmc.cs | Adds C# satellite-assembly example snippet referenced by remarks. |
| snippets/csharp/System.Resources/ResourceManager/Overview/Project.csproj | Adds C# snippet project for ResourceManager overview examples. |
| snippets/csharp/System.Resources/ResourceManager/Overview/example2.cs | Adds C# console table example snippet referenced by GetObject remarks. |
| snippets/csharp/System.Resources/ResourceManager/Overview/example11.cs | Adds C# resource generation snippet referenced by GetObject remarks. |
| snippets/csharp/System.Resources/ResourceManager/Overview/example1.cs | Adds C# serializable struct snippet referenced by GetObject remarks. |
| snippets/csharp/System.Resources/ResourceManager/Overview/example.cs | Adds C# culture-switching example snippet referenced by type remarks. |
| snippets/csharp/System.Resources/ResourceManager/Overview/ctor1.cs | Adds C# ctor snippets referenced by ResourceManager remarks. |
| snippets/csharp/System.Resources/ResourceManager/GetObject/shownumbers.cs | Adds C# GetObject example snippet. |
| snippets/csharp/System.Resources/ResourceManager/GetObject/Project.csproj | Adds C# snippet project for ResourceManager.GetObject examples. |
| snippets/csharp/System.Resources/ResourceManager/GetObject/numberinfo.cs | Adds C# serializable type snippet for GetObject examples. |
| snippets/csharp/System.Resources/ResourceManager/GetObject/createresources.cs | Adds C# resource generation snippet for GetObject examples. |
| snippets/csharp/System.Resources/ResourceManager/.ctor/Project.csproj | Adds C# snippet project for ResourceManager constructor docs. |
| snippets/csharp/System.Resources/ResourceManager/.ctor/greet.cs | Adds C# greeting example snippet referenced by ctor remarks. |
| snippets/csharp/System.Resources/ResourceManager/.ctor/example.cs | Adds C# “Hello World” ResourceManager example referenced by ctor remarks. |
| snippets/csharp/System.Resources/ResourceManager/.ctor/ctor1.cs | Adds C# ctor snippet referenced by ResourceManager ctor remarks. |
| snippets/csharp/System.Resources/NeutralResourcesLanguageAttribute/Overview/Project.csproj | Adds C# snippet project for NeutralResourcesLanguageAttribute examples. |
| snippets/csharp/System.Resources/NeutralResourcesLanguageAttribute/Overview/example.cs | Adds C# example snippet for NeutralResourcesLanguageAttribute. |
| snippets/csharp/System.Resources/MissingManifestResourceException/Overview/showtime.cs | Adds C# snippet referenced by ResourceManager remarks and exception docs. |
| snippets/csharp/System.Resources/MissingManifestResourceException/Overview/showdate2.cs | Adds C# snippet referenced by ResourceManager.GetString remarks. |
| snippets/csharp/System.Resources/MissingManifestResourceException/Overview/showdate1.cs | Adds C# snippet referenced by ResourceManager.GetString remarks. |
| snippets/csharp/System.Resources/MissingManifestResourceException/Overview/showdate.cs | Adds C# snippet referenced by MissingManifestResourceException/ResourceManager docs. |
| snippets/csharp/System.Resources/MissingManifestResourceException/Overview/Project.csproj | Adds C# snippet project for MissingManifestResourceException examples. |
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.
Contributes to #12613.
Also removes .NET Framework remarks.