Document ManualEventReader #3384
Closed
Conversation
This file contains 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
alice-i-cecile
added
A-ECS
mockersf
reviewed
Dec 19, 2021
Comment on lines
+185
to
+187
| /// To get around this, you can store a [ManualEventReader] in a [Local] to help track events seen | ||
| /// when working directly with `ResMut<Events<T>>`, | ||
| /// allowing you to read and write events from within the same system. |
There was a problem hiding this comment.
Reading this, I find it confusing. Why something named ManualEventReader would work better than using EventReader?. Maybe a code sample in doc could help to show how ManualEventReader works with ResMut<Events<T>> to provide the same functionality as a EventReader and a EventWriter?
|
FYI, I'm a bit nervous about these docs: #2765 basically deprecates this usage pattern. If that is merged before this PR, the docs should be documented to reflect that (and I honestly wouldn't hate hiding |
|
Good call. I'm going to close this out. |
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.
Objective
Solution
StatetoDoubleBufferStatefor better clarity and CTRL+F usability.