Deduplicate XML documentation using inheritdoc cref - #29
Merged
Conversation
Copilot
AI
changed the title
docs: deduplicate XML documentation with inheritdoc cref
docs: deduplicate XML documentation using inheritdoc cref
Jul 27, 2026
Copilot created this pull request from a session on behalf of
Tyrrrz
July 27, 2026 23:12
View session
Tyrrrz
marked this pull request as ready for review
July 28, 2026 07:54
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## prime #29 +/- ##
=======================================
Coverage 96.62% 96.62%
=======================================
Files 8 8
Lines 415 415
Branches 70 70
=======================================
Hits 401 401
Misses 10 10
Partials 4 4 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reduces repeated XML documentation across overload families by replacing duplicated <summary> blocks with <inheritdoc cref="..."/>, keeping one canonical doc comment per method group.
Changes:
- Replaced repeated
<summary>blocks forWriteNumberValue,WriteNumber,WriteStringValue, andWriteStringoverloads with<inheritdoc cref="..."/>inOptionalExtensions. - Replaced a duplicated
<summary>on theGetJsonAsync(string, CancellationToken)overload with<inheritdoc cref="..."/>inHttpExtensions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| JsonExtensions/Writing/OptionalExtensions.cs | Deduplicates XML docs across nullable writer overload families via <inheritdoc cref="..."/>. |
| JsonExtensions/Http/HttpExtensions.cs | Deduplicates the GetJsonAsync overload summary via <inheritdoc cref="..."/>. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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>
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.
Replaces repeated identical
<summary>blocks across overload families with<inheritdoc cref="..."/>, keeping one canonical doc per group.Duplicate groups deduplicated
Writing/OptionalExtensions.csWriteNumberValueWriteNumberValue(Utf8JsonWriter, byte?)Writing/OptionalExtensions.csWriteNumberWriteNumber(Utf8JsonWriter, string, byte?)Writing/OptionalExtensions.csWriteStringValueWriteStringValue(Utf8JsonWriter, DateTime?)Writing/OptionalExtensions.csWriteStringWriteString(Utf8JsonWriter, string, DateTime?)Http/HttpExtensions.csGetJsonAsyncGetJsonAsync(HttpClient, Uri, CancellationToken)cref format
Explicit
crefis used throughout (not bare<inheritdoc/>) since these are sibling overloads, not base/interface members. The receiver type (Utf8JsonWriter,HttpClient) is included as the firstcrefparameter — required because C# 14extension(T)block members lower with the receiver as the first parameter in XML doc member IDs: