Skip to content

Clean EventBus docs and comments#1

Closed
Wehlney wants to merge 1 commit into
mainfrom
cleanup-doc-comments
Closed

Clean EventBus docs and comments#1
Wehlney wants to merge 1 commit into
mainfrom
cleanup-doc-comments

Conversation

@Wehlney

@Wehlney Wehlney commented Jul 3, 2026

Copy link
Copy Markdown
Owner

No description provided.

Copilot AI review requested due to automatic review settings July 3, 2026 16:14
@Wehlney Wehlney closed this Jul 3, 2026

Copilot AI left a comment

Copy link
Copy Markdown

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 focuses on cleaning up documentation and inline comments across the EventBus packages, aiming to make guidance clearer and remove redundant file/header notes.

Changes:

  • Refined eventbus/README.md wording and updated Git install URLs.
  • Simplified/standardized XML docs and inline comments across core and Reflex bindings.
  • Removed redundant “File:” header comments from several source files.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
eventbus/README.md Updates README wording and Git install URL examples.
eventbus/com.wehlney.eventbus/Runtime/Core/SubscriptionBag.cs Rewrites class summary comment for clarity.
eventbus/com.wehlney.eventbus/Runtime/Core/Subscriber.cs Removes redundant file header comment.
eventbus/com.wehlney.eventbus/Runtime/Core/Publisher.cs Removes redundant file header and refines an inline comment.
eventbus/com.wehlney.eventbus/Runtime/Core/Events.cs Condenses marker/base-event documentation and removes some comment noise.
eventbus/com.wehlney.eventbus/Runtime/Core/EventBus.cs Removes decorative “Helpers” separator comments.
eventbus/com.wehlney.eventbus.reflex/Runtime/Reflex/PurrNetPubSubBindings.cs Removes redundant file header comment.
eventbus/com.wehlney.eventbus.reflex/Runtime/Reflex/PubSubBindings.cs Condenses binding docs and removes a large header comment block.
Comments suppressed due to low confidence (1)

eventbus/com.wehlney.eventbus/Runtime/Core/Events.cs:13

  • IEventMarker ends with an extra ; after the interface body (};). This parses as an empty declaration but is unusual and can trigger style/analyzer warnings. Consider removing the trailing semicolon.
    public interface IEventMarker
    {
    };

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


// HARD GUARD:
// Interfaces are Marker only and shall not be used as Publishers - Use Records instead
// Interfaces are marker routes only; publishers must use concrete event records.
Comment on lines +11 to 12
/// Registers publisher and subscriber bindings for a concrete event type; sticky bindings replay the last value to late subscribers.
/// </summary>
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.

2 participants