Match XML docs to Collection return types#397
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Aligns XML documentation with the current public API return/out-parameter types after the List<T> -> Collection<T> / ReadOnlyCollection<T> change, ensuring generated docs accurately describe the exposed types without changing behavior.
Changes:
- Update
StringHistory.StringListdocs to describe a read-only collection rather than a list. - Update
FileEx.EnumerateDirectories/EnumerateDirectoryparameter docs to describe output collections and remove “list of” phrasing for theIEnumerable<string>input. - Minor wording update in an inline comment to match the updated terminology.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| Utilities/StringHistory.cs | Updates the StringList XML summary to match ReadOnlyCollection<string>. |
| Utilities/FileEx.cs | Updates XML docs (and one inline comment) to match Collection<T> out parameters and IEnumerable<string> input. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #397 +/- ##
========================================
Coverage 46.19% 46.19%
========================================
Files 13 13
Lines 1156 1156
Branches 107 107
========================================
Hits 534 534
Misses 592 592
Partials 30 30 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Summary
Updates doc comments that still described the enumerate out-parameters and
StringHistory.StringListas a "list" after they were changed toCollection<T>/ReadOnlyCollection<T>:FileEx.EnumerateDirectories/EnumerateDirectory:fileList/directoryListparams are now "Output collection ...";sourceList(nowIEnumerable<string>) drops "list of".StringHistory.StringList: "Gets the read-only collection of stored strings."Docs-only; no code or API change.
Verification
dotnet build- 0 warnings / 0 errors.dotnet format style --verify-no-changesclean.Addresses a Copilot finding on the develop->main release PR (#394).
🤖 Generated with Claude Code