Clean EventBus docs and comments#1
Closed
Wehlney wants to merge 1 commit into
Closed
Conversation
There was a problem hiding this comment.
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.mdwording 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
IEventMarkerends 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> |
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.