Move remarks back from conceptual docs repo (CustomReflectionContext) - #129404
Merged
Conversation
Contributor
|
Tagging subscribers to this area: @steveisok, @dotnet/area-system-reflection |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR moves supplemental documentation for System.Reflection.Context.CustomReflectionContext into the in-repo XML doc comments, including a linked example snippet sourced from the test project, and updates contributor guidance for referencing examples.
Changes:
- Replaces the external “supplemental remarks” link with in-source markdown-formatted
<remarks>content and adds an<example>that sources a snippet from tests. - Adds a new
CustomReflectionContext.Examples.csfile under the test project and includes it in the test.csprojfor snippet validation. - Updates the “adding API” guidelines to describe using
<example>+<code ... source=... region=... />for examples.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/libraries/System.Reflection.Context/tests/System.Reflection.Context.Tests.csproj | Includes the new CustomReflectionContext.Examples.cs in the test compilation list. |
| src/libraries/System.Reflection.Context/tests/CustomReflectionContext.Examples.cs | Adds a docs snippet source file intended to be validated during test runs. |
| src/libraries/System.Reflection.Context/src/System/Reflection/Context/CustomReflectionContext.cs | Inlines markdown <remarks> and adds an <example> that pulls from the new test snippet file. |
| docs/coding-guidelines/adding-api-guidelines.md | Documents the <example>/<code ... /> approach (and when to use code-csharp instead). |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
jkotas
reviewed
Jun 15, 2026
jkotas
reviewed
Jun 15, 2026
jkotas
approved these changes
Jun 15, 2026
3 tasks
Co-authored-by: Jan Kotas <jkotas@microsoft.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
jkotas
approved these changes
Jun 16, 2026
gewarren
commented
Jun 16, 2026
jkotas
approved these changes
Jun 16, 2026
steveisok
approved these changes
Jun 16, 2026
This was referenced Jun 17, 2026
Open
jkotas
approved these changes
Jun 17, 2026
Member
|
/ba-g infrastructure timeouts |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 dotnet/dotnet-api-docs#12613.
We're moving supplemental API remarks out of the dotnet/docs repo and back into either: