Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the generated “automated friendly overloads” documentation for MessagePackSerializer so that XML doc comments reference the correct methods (particularly for the source-generated type-shape scenarios), improving doc-link accuracy and avoiding broken <see cref="..."/> references.
Changes:
- Updated the T4 template to generate correct
<see cref>targets for witness-type (TProvider) overloads in source-generation-required remarks. - Regenerated the corresponding
.csoutput so the doc comments now point toSerialize*/Deserialize*{T, TProvider}overloads rather than unrelated methods.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Nerdbank.MessagePack/MessagePackSerializer.AutomatedFriendlyOverloads.tt | Adjusts T4 generation logic to emit correct <see cref> strings for the intended alternative overloads. |
| src/Nerdbank.MessagePack/MessagePackSerializer.AutomatedFriendlyOverloads.cs | Regenerated output reflecting corrected XML doc comment method references. |
This was referenced Aug 27, 2026
This was referenced Sep 3, 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.
Fix methods referenced in xml doc comments for MessagePackSerializer