Fix XML doc typos, stale TODOs, and exception message wording#76
Merged
Conversation
Result.cs: - Fix "error errorMessage" → "error message" in constructor docs and exception messages - Fix extra > in <see cref="Result"/>> (3 occurrences) - Use <paramref> and <typeparamref> in XML doc remarks - Fix missing article: "will contain message" → "will contain a message" Try.cs: - Add missing periods to <returns> doc comments - Remove trailing whitespace from <returns> text - Fix spacing: 3 blank lines between Run<T> and RunAsync<T> - Remove trailing blank lines at end of file Tests: - Remove stale TODO comments from RunFuncTests and RunAsyncFuncTests Verified: 0 warnings, 96 tests pass, ReSharper inspectcode clean Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR cleans up XML documentation and minor test-file maintenance items in the Try Pattern library to improve API docs quality and remove stale comments.
Changes:
- Fix XML doc typos/markup (e.g.,
error errorMessage, malformed<see cref>tags) and improve remarks using<paramref>/<typeparamref>. - Adjust a few XML
<returns>descriptions and exception message wording for consistency. - Remove stale TODO comments in test classes.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tests/Wolfgang.TryPattern.Tests/RunFuncTests.cs | Removes stale TODO comment from the test class declaration. |
| tests/Wolfgang.TryPattern.Tests/RunAsyncFuncTests.cs | Removes stale TODO comment from the async test class declaration. |
| src/Wolfgang.TryPattern/Try.cs | Minor XML doc punctuation tweaks and whitespace/spacing adjustments. |
| src/Wolfgang.TryPattern/Result.cs | Fixes XML doc typos/markup and refines exception messages and remarks wording. |
The constructor uses IsNullOrWhiteSpace but the XML remarks only mentioned null/empty. Add "or whitespace" to both Result and Result<T> constructor remarks. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.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.
Summary
>in<see cref="Result"/>>XML doc tags (3 occurrences)<paramref>and<typeparamref>in XML doc remarks<returns>doc comments in Try.csVerification
dotnet build— 0 warnings, 0 errorsdotnet test— 96/96 passjb inspectcode— 0 issues (WARNING + SUGGESTION level)Test plan
🤖 Generated with Claude Code