Deduplicate repeated XML docs in PowerKit with targeted <inheritdoc/> - #97
Merged
Conversation
Copilot
AI
changed the title
[WIP] Audit and refactor XML documentation comments across repositories
Deduplicate repeated XML docs in PowerKit with targeted Jul 27, 2026
<inheritdoc/>
Tyrrrz
marked this pull request as ready for review
July 27, 2026 17:31
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## prime #97 +/- ##
=======================================
Coverage 86.46% 86.46%
=======================================
Files 78 78
Lines 1411 1411
Branches 243 243
=======================================
Hits 1220 1220
Misses 138 138
Partials 53 53 ☔ 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 duplicated XML documentation across several overloads in PowerKit by replacing repeated <summary> blocks with <inheritdoc/> references to a canonical overload, keeping the “source of truth” docs in one place.
Changes:
- Replaced repeated XML doc blocks on overload wrappers in checksum (
Adler32,Crc32) and compression (Deflate) APIs with<inheritdoc cref="..."/>. - Switched delegating overloads in
EnumExtensionsandFileExtensionsto inherit documentation from their canonical overloads. - Updated
HttpClientExtensionsoverloads to use<inheritdoc />(but these needcrefto actually inherit docs from the intended overload).
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| PowerKit/Extensions/HttpClientExtensions.cs | Deduplicates docs for string overloads of HTTP helpers (needs cref to correctly inherit). |
| PowerKit/Extensions/FileExtensions.cs | Makes Contains(string, byte[]) inherit docs from the ReadOnlySpan<byte> overload. |
| PowerKit/Extensions/EnumExtensions.cs | Makes convenience overloads inherit docs from the overloads that define the canonical behavior. |
| PowerKit/Deflate.cs | Makes span-based overloads inherit docs from the byte[] overloads. |
| PowerKit/Crc32.cs | Makes span-based overload inherit docs from the byte[] overload. |
| PowerKit/Adler32.cs | Makes span-based overload inherit docs from the byte[] overload. |
Comments suppressed due to low confidence (1)
PowerKit/Extensions/HttpClientExtensions.cs:75
<inheritdoc />without acrefwon’t inherit XML docs for this overload because it’s not overriding/implementing a base/interface member. Point it explicitly at theUrioverload to actually reuse its documentation.
/// <inheritdoc />
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Tyrrrz
approved these changes
Jul 27, 2026
This was referenced Aug 1, 2026
This was referenced Aug 1, 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.
This PR audits duplicate XML documentation in
Tyrrrz/PowerKitand replaces repeated blocks with inheritance-based docs. Canonical docs were retained on primary overloads, and delegating/related overloads now inherit from them.Overload-level doc deduplication
<inheritdoc/>or<inheritdoc cref="..."/>.Adler32.Hash(ReadOnlySpan<byte>)→ inherits fromHash(byte[])Crc32.Hash(ReadOnlySpan<byte>)→ inherits fromHash(byte[])Deflate.Compress(ReadOnlySpan<byte>)→ inherits fromCompress(byte[])Deflate.Decompress(ReadOnlySpan<byte>)→ inherits fromDecompress(byte[])EnumExtensions.ParseOrNull<TEnum>(string?)→ inherits fromParseOrNull<TEnum>(string, bool)EnumExtensions.ParseOrDefault<TEnum>(string?, TEnum)→ inherits fromParseOrDefault<TEnum>(string, bool, TEnum)FileExtensions.Contains(string, byte[])→ inherits fromContains(string, ReadOnlySpan<byte>)HttpClientExtensions.DownloadAsync(string, ...)/HeadAsync(string, ...)→ inherits from URI overload docsCanonical selection
Example pattern used: