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

Rename apply_system_buffers to apply_deferred #8726

Merged
merged 10 commits into from
Jun 2, 2023
Merged

Conversation

alice-i-cecile
Copy link
Member

@alice-i-cecile alice-i-cecile commented May 31, 2023

Objective

  • apply_system_buffers is an unhelpful name: it introduces a new internal-only concept
  • this is particularly rough for beginners as reasoning about how commands work is a critical stumbling block

Solution

  • rename apply_system_buffers to the more descriptive apply_deferred
  • rename related fields, arguments and methods in the internals fo bevy_ecs for consistency
  • update the docs

Changelog

apply_system_buffers has been renamed to apply_deferred, to more clearly communicate its intent and relation to Deferred system parameters like Commands.

Migration Guide

  • apply_system_buffers has been renamed to apply_deferred
  • the apply_system_buffers method on the System trait has been renamed to apply_deferred
  • the is_apply_system_buffers function has been replaced by is_apply_deferred
  • Executor::set_apply_final_buffers is now Executor::set_apply_final_deferred
  • Schedule::apply_system_buffers is now Schedule::apply_deferred

@alice-i-cecile alice-i-cecile added C-Usability A simple quality-of-life change that makes Bevy easier to use C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide A-ECS Entities, components, systems, and events labels May 31, 2023
@alice-i-cecile alice-i-cecile added this to the 0.11 milestone May 31, 2023
@github-actions
Copy link
Contributor

You added a new example but didn't update the readme. Please run cargo run -p build-templated-pages -- update examples to update it, and commit the file change.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this file name needs to be changed.

Copy link
Contributor

@iiYese iiYese left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change example module name to reflect renaming.

Copy link
Member

@JoJoJet JoJoJet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good change. I've always found it difficult to write succinct documentation surrounding system buffers.

alice-i-cecile and others added 2 commits June 1, 2023 20:40
Co-authored-by: JoJoJet <21144246+JoJoJet@users.noreply.github.com>
@github-actions
Copy link
Contributor

github-actions bot commented Jun 2, 2023

You added a new example but didn't update the readme. Please run cargo run -p build-templated-pages -- update examples to update it, and commit the file change.

1 similar comment
@github-actions
Copy link
Contributor

github-actions bot commented Jun 2, 2023

You added a new example but didn't update the readme. Please run cargo run -p build-templated-pages -- update examples to update it, and commit the file change.

@alice-i-cecile alice-i-cecile requested review from JoJoJet, iiYese and inodentry and removed request for iiYese June 2, 2023 12:21
Copy link
Member

@JoJoJet JoJoJet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, just a quick question though.

CHANGELOG.md Outdated Show resolved Hide resolved
crates/bevy_ecs/src/schedule/executor/mod.rs Show resolved Hide resolved
Co-authored-by: JoJoJet <21144246+JoJoJet@users.noreply.github.com>
CHANGELOG.md Outdated Show resolved Hide resolved
@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 Jun 2, 2023
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-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide C-Usability A simple quality-of-life change that makes Bevy easier to use 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