Remove unused exceptions, add comments#22
Merged
KuraiAndras merged 3 commits intomasterfrom Jun 15, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR removes unused exception types and enriches public APIs with XML documentation.
- Deleted two obsolete exception classes.
- Added XML comments to
ICourier,CourierOptions, andCourierInjector. - Ensured overloads and extension methods are properly documented.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| MediatR.Courier/ICourier.cs | Added XML summaries and <inheritdoc/> tags to interface methods; introduced overloads. |
| MediatR.Courier/Exceptions/UnknownMethodException.cs | Removed unused exception type. |
| MediatR.Courier/Exceptions/MethodNotImplementedException.cs | Removed unused exception type. |
| MediatR.Courier/CourierOptions.cs | Documented the behavior and default of CaptureThreadContext. |
| MediatR.Courier/CourierInjector.cs | Documented extension methods for DI registration. |
Comments suppressed due to low confidence (4)
MediatR.Courier/ICourier.cs:21
- The XML docs for this overload do not include a
<param name="cancellationToken">description. Please document thecancellationTokenparameter to clarify its purpose.
void Subscribe<TNotification>(Action<TNotification, CancellationToken> handler)
MediatR.Courier/ICourier.cs:68
- Method name
UnSubscribedeviates from the .NET convention (Unsubscribeshould be one word in PascalCase). Consider renaming toUnsubscribefor consistency.
void UnSubscribe<TNotification>(Action<TNotification> handler)
MediatR.Courier/Exceptions/UnknownMethodException.cs:1
- Removing
UnknownMethodExceptionis a breaking change to the public API. Ensure this removal is called out in the changelog or consider marking it obsolete before removal.
using System.Runtime.Serialization;
MediatR.Courier/Exceptions/MethodNotImplementedException.cs:1
- Removing
MethodNotImplementedExceptionis a breaking change to the public API. Ensure this removal is called out in the changelog or consider marking it obsolete before removal.
using System.Runtime.Serialization;
|
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.



No description provided.