Remove async/sync requirements around eventbus on vs emit #281
Conversation
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
Before this PR, the text says that if an event receiver is using on() to receive events, the sender must emit using emit(), and respectively on_async() with emit_async() as if there are two different worlds of events. My reading of the code and brief experimentation says that isn't true: it doesn't matter which on vs which emit is used. This PR removes the text saying so, and rephrases emit*() documentation to be clearer that the choice is forced by whether you are calling from synchronous or asynchronous code. (Local lint-markdown does not pass for me even before making these changes which I guess is probably related to linter version - I haven't made any attempt to debug)
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
Before this PR, the text says that if an event receiver is using on() to receive events, the sender must emit using emit(), and respectively on_async() with emit_async() as if there are two different worlds of events.
My reading of the code and brief experimentation says that isn't true: it doesn't matter which on vs which emit is used.
This PR removes the text saying so, and rephrases emit*() documentation to be clearer that the choice is forced by whether you are calling from synchronous or asynchronous code.
(Local lint-markdown does not pass for me even before making these changes which I guess is probably related to linter version - I haven't made any attempt to debug)