Skip to content

Remove unused exceptions, add comments#22

Merged
KuraiAndras merged 3 commits intomasterfrom
remove-unused-exceptions
Jun 15, 2025
Merged

Remove unused exceptions, add comments#22
KuraiAndras merged 3 commits intomasterfrom
remove-unused-exceptions

Conversation

@KuraiAndras
Copy link
Owner

No description provided.

@KuraiAndras KuraiAndras requested a review from Copilot June 15, 2025 21:41

This comment was marked as outdated.

@KuraiAndras KuraiAndras requested a review from Copilot June 15, 2025 21:51
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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, and CourierInjector.
  • 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 the cancellationToken parameter to clarify its purpose.
void Subscribe<TNotification>(Action<TNotification, CancellationToken> handler)

MediatR.Courier/ICourier.cs:68

  • Method name UnSubscribe deviates from the .NET convention (Unsubscribe should be one word in PascalCase). Consider renaming to Unsubscribe for consistency.
void UnSubscribe<TNotification>(Action<TNotification> handler)

MediatR.Courier/Exceptions/UnknownMethodException.cs:1

  • Removing UnknownMethodException is 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 MethodNotImplementedException is 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;

@sonarqubecloud
Copy link

@KuraiAndras KuraiAndras merged commit 5a0cf76 into master Jun 15, 2025
2 checks passed
@KuraiAndras KuraiAndras deleted the remove-unused-exceptions branch June 15, 2025 21:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant