Improve docs around using NerdbankMessagePackFormatter#1439
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Improves guidance and discoverability for configuring NerdbankMessagePackFormatter (especially around PolyType witness classes and serializer customization) by enhancing API docs, DocFX documentation, and adding/adjusting sample code used in the docs.
Changes:
- Expanded XML docs on
NerdbankMessagePackFormatterconstructor with remarks, examples, and external references. - Updated DocFX extensibility documentation with clearer instructions and embedded code snippets.
- Added a new
samples/Extensibility.cssample (and adjusted the samples project) to back the documentation snippets.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/StreamJsonRpc/NerdbankMessagePackFormatter.cs | Adds richer XML documentation, including example code references and links for TypeShapeProvider/witness classes. |
| samples/Samples.csproj | Multi-targets samples and configures them to run under Microsoft.Testing.Platform with xunit v3. |
| samples/NativeAOT/SystemTextJson.cs | Suppresses CS8892 warning for ignored Main method in sample code. |
| samples/NativeAOT/NerdbankMessagePack.cs | Suppresses CS8892 and refines witness-class comment for the NB MessagePack NativeAOT sample. |
| samples/Extensibility.cs | Introduces a sample used by DocFX/API docs to demonstrate creating/configuring NerdbankMessagePackFormatter. |
| docfx/docs/extensibility.md | Adds more explicit setup guidance and includes sample snippets for NerdbankMessagePackFormatter configuration. |
matthew-j-clark
approved these changes
May 20, 2026
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.
No description provided.