Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Merged by Bors] - Optimise EventReader::clear() and improve documentation #7471

Closed

Conversation

tim-blackbird
Copy link
Contributor

@tim-blackbird tim-blackbird commented Feb 2, 2023

Objective

Clearing the reader doesn't require iterating the events. Updating the last_event_count of the reader is enough.

I rewrote part of the documentation as some of it was incorrect or harder to understand than necessary.

Changelog

Added ManualEventReader::clear()

@tim-blackbird tim-blackbird changed the title Optimise EventReader::clear(). Improve documentation. Optimise EventReader::clear() and improve documentation Feb 2, 2023
@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-ECS Entities, components, systems, and events C-Code-Quality A section of code that is hard to understand or change labels Feb 2, 2023
@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Feb 3, 2023
@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Feb 3, 2023
# Objective

Clearing the reader doesn't require iterating the events. Updating the `last_event_count` of the reader is enough.

I rewrote part of the documentation as some of it was incorrect or harder to understand than necessary.

## Changelog

Added `ManualEventReader::clear()`

Co-authored-by: devil-ira <justthecooldude@gmail.com>
@bors bors bot changed the title Optimise EventReader::clear() and improve documentation [Merged by Bors] - Optimise EventReader::clear() and improve documentation Feb 3, 2023
@bors bors bot closed this Feb 3, 2023
@tim-blackbird tim-blackbird deleted the optimise-event-clear branch February 5, 2023 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ECS Entities, components, systems, and events C-Code-Quality A section of code that is hard to understand or change C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants