{{ message }}
Repository navigation
docs: correct Event class description in event-based-asynchronous README - #3624
Open
1wu-davy-2 wants to merge 1 commit into
Open
1wu-davy-2 wants to merge 1 commit into
1wu-davy-2 wants to merge 1 commit into
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- 8de76a0: docs: correct Event class description in event-based-asynchronous README
Files Processed (1)
- event-based-asynchronous/README.md (4 hunks)
Actionable Comments (0)
Skipped Comments (4)
-
event-based-asynchronous/README.md [44-49]
readability: "Clarify event abstraction and synchronization model"
-
event-based-asynchronous/README.md [75-78]
readability: "Explain createAsync wrapper and its relation to AsyncEvent"
-
event-based-asynchronous/README.md [80-82]
readability: "Terminology consistency (runtime vs. eventTime)"
-
event-based-asynchronous/README.md [151-152]
readability: "Clarify lifecycle of synchronous event tracking"
This branch has not been deployed
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
1 participant
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.
Description
The README claimed that
Eventis an abstract class with two concrete subclasses,AsyncEventandSyncEvent. Neither statement matches the code:Eventis aninterfacedeclaringstart(),stop()andstatus().SyncEventclass. The only implementation isAsyncEvent, which carries asynchronousflag.EventManager.createEvent(Duration, boolean isSynchronous)buildsnew AsyncEvent(id, time, isSynchronous)for both kinds, so synchronous and asynchronous events are the same class.AsyncEvent.start()always spawns its own thread, so a synchronous event does not "run on the main thread and block it". The real distinction is thatEventManagerpermits only one synchronous event at a time, tracked by thecurrentlyRunningSyncEventfield.The
createAsyncandcreatesnippets were also replaced with the actual implementations.Checklist
event-based-asynchronous/README.md)Event.java,AsyncEvent.javaandEventManager.javaSyncEventas a class, or toEventas an abstract classAssisted by AI tools for initial analysis; all changes manually verified and tested.