Skip to content

Deduplicate XML documentation using inheritdoc cref - #29

Merged
Tyrrrz merged 3 commits into
primefrom
copilot/audit-refactor-xml-docs
Jul 28, 2026
Merged

Deduplicate XML documentation using inheritdoc cref#29
Tyrrrz merged 3 commits into
primefrom
copilot/audit-refactor-xml-docs

Conversation

Copilot AI commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Replaces repeated identical <summary> blocks across overload families with <inheritdoc cref="..."/>, keeping one canonical doc per group.

Duplicate groups deduplicated

File Method family Canonical overload Dupes
Writing/OptionalExtensions.cs WriteNumberValue WriteNumberValue(Utf8JsonWriter, byte?) 10
Writing/OptionalExtensions.cs WriteNumber WriteNumber(Utf8JsonWriter, string, byte?) 10
Writing/OptionalExtensions.cs WriteStringValue WriteStringValue(Utf8JsonWriter, DateTime?) 2
Writing/OptionalExtensions.cs WriteString WriteString(Utf8JsonWriter, string, DateTime?) 2
Http/HttpExtensions.cs GetJsonAsync GetJsonAsync(HttpClient, Uri, CancellationToken) 1

cref format

Explicit cref is used throughout (not bare <inheritdoc/>) since these are sibling overloads, not base/interface members. The receiver type (Utf8JsonWriter, HttpClient) is included as the first cref parameter — required because C# 14 extension(T) block members lower with the receiver as the first parameter in XML doc member IDs:

/// <summary>
/// Writes <paramref name="value"/> as a JSON number, or a JSON null if <paramref name="value"/> is null.
/// </summary>
public void WriteNumberValue(byte? value) { ... }

/// <inheritdoc cref="WriteNumberValue(Utf8JsonWriter, byte?)"/>
public void WriteNumberValue(decimal? value) { ... }

Copilot AI changed the title docs: deduplicate XML documentation with inheritdoc cref docs: deduplicate XML documentation using inheritdoc cref Jul 27, 2026
Copilot AI requested a review from Tyrrrz July 27, 2026 23:12
@Tyrrrz Tyrrrz added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 28, 2026
@Tyrrrz
Tyrrrz marked this pull request as ready for review July 28, 2026 07:54
Copilot AI review requested due to automatic review settings July 28, 2026 07:54
@Tyrrrz Tyrrrz changed the title docs: deduplicate XML documentation using inheritdoc cref Deduplicate XML documentation using inheritdoc cref Jul 28, 2026
@codecov

codecov Bot commented Jul 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.62%. Comparing base (fdd2432) to head (c4af825).
⚠️ Report is 1 commits behind head on prime.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 for WriteNumberValue, WriteNumber, WriteStringValue, and WriteString overloads with <inheritdoc cref="..."/> in OptionalExtensions.
  • Replaced a duplicated <summary> on the GetJsonAsync(string, CancellationToken) overload with <inheritdoc cref="..."/> in HttpExtensions.

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.

Comment thread JsonExtensions/Writing/OptionalExtensions.cs Outdated
Comment thread JsonExtensions/Http/HttpExtensions.cs Outdated
Tyrrrz and others added 2 commits July 28, 2026 10:58
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>
@Tyrrrz
Tyrrrz merged commit fa01a63 into prime Jul 28, 2026
5 checks passed
@Tyrrrz
Tyrrrz deleted the copilot/audit-refactor-xml-docs branch July 28, 2026 07:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants