Add XML docs to all publicly exposed extensions#2
Merged
Conversation
Agent-Logs-Url: https://github.com/Tyrrrz/PowerKit/sessions/6da176b4-8187-4286-a583-06c4a3e344a1 Co-authored-by: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
Tyrrrz
April 12, 2026 11:17
View session
Tyrrrz
approved these changes
Apr 12, 2026
| } | ||
|
|
||
| /// <summary> | ||
| /// Projects each element of the async sequence to an <see cref="IEnumerable{T}"/> |
Owner
There was a problem hiding this comment.
Suggested change
| /// Projects each element of the async sequence to an <see cref="IEnumerable{T}"/> | |
| /// Projects each element of the async sequence to an <see cref="IEnumerable{T}" /> |
Always leave a space before />
Contributor
Author
There was a problem hiding this comment.
Fixed in 9e94ffc — added a space before /> in all self-closing XML doc tags across all files.
Agent-Logs-Url: https://github.com/Tyrrrz/PowerKit/sessions/ad2a6f68-313c-436f-a9b0-afd0e92a1fe4 Co-authored-by: Tyrrrz <1935960+Tyrrrz@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds XML <summary> documentation (and a few <inheritdoc /> usages) to extension methods and the Disposable utility to improve IntelliSense and generated API docs consistency across PowerKit.
Changes:
- Added
<summary>XML docs to extension methods across thePowerKit.Extensionsset. - Added class/member XML docs to
Disposable, including docs forNull,Create, andMerge. - Standardized brief behavioral descriptions for string/stream/path/sequence helpers.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| PowerKit/Extensions/TextReaderExtensions.cs | Adds XML summary for ReadLinesAsync. |
| PowerKit/Extensions/StringExtensions.cs | Adds XML summaries for substring helpers, truncation, word separation, and casing helpers. |
| PowerKit/Extensions/StringBuilderExtensions.cs | Adds XML summaries for AppendIfNotEmpty and Trim. |
| PowerKit/Extensions/StreamExtensions.cs | Adds XML summaries for CopyToAsync overloads (autoflush/progress variants). |
| PowerKit/Extensions/PathExtensions.cs | Adds XML summaries for invalid char helpers and EscapeFileName. |
| PowerKit/Extensions/FunctionalExtensions.cs | Adds XML summaries for Pipe and NullIf* helpers. |
| PowerKit/Extensions/ExceptionExtensions.cs | Adds XML summary for GetSelfAndDescendants. |
| PowerKit/Extensions/EnumerableExtensions.cs | Adds XML summaries for singleton wrapping, filtering, and *OrNull helpers. |
| PowerKit/Extensions/ComparableExtensions.cs | Adds XML summaries for Clamp, Min, Max. |
| PowerKit/Extensions/AsyncEnumerableExtensions.cs | Adds XML summaries for async sequence helpers (TakeAsync, SelectManyAsync, ToListAsync, GetAwaiter). |
| PowerKit/Extensions/AggregateExceptionExtensions.cs | Adds XML summary for TryGetSingle. |
| PowerKit/Disposable.cs | Adds XML docs for the type and core factory/composition members. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This was referenced May 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.
Adds
/// <summary>XML documentation to every public method and property across all extension files andDisposable.ToSingletonEnumerable,WhereNotNull(reference + value type),WhereNotNullOrEmpty,WhereNotNullOrWhiteSpace,FirstOrNull,LastOrNull,ElementAtOrNullTakeAsync,SelectManyAsync,ToListAsync,GetAwaiterClamp,Min,MaxGetSelfAndDescendantsPipe,NullIf,NullIfDefault,NullIfEmpty,NullIfWhiteSpaceGetInvalidFileNameChars,GetInvalidPathChars,EscapeFileNameCopyToAsyncoverloadsSubstringUntil,SubstringUntilLast,SubstringAfter,SubstringAfterLast,Truncate,SeparateWords,ToKebabCase,ToSnakeCaseAppendIfNotEmpty,TrimReadLinesAsyncTryGetSingleDispose,Null,Create,Merge