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.

Sign up for GitHub

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

Jump to bottom

Merge ScheduleRunnerSettings into ScheduleRunnerPlugin #8585

Merged
merged 1 commit into from
May 10, 2023
Merged

Merge ScheduleRunnerSettings into ScheduleRunnerPlugin #8585

merged 1 commit into from
May 10, 2023

Conversation

SpecificProtagonist
Copy link
Contributor

Objective

ScheduleRunnerPlugin was still configured via a resource, meaning users would be able to change the settings while the app is running, but the changes wouldn't have an effect.

Solution

Configure plugin directly

Changelog

  • Changed: merged ScheduleRunnerSettings into ScheduleRunnerPlugin

Migration Guide

  • instead of inserting the ScheduleRunnerSettings resource, configure the ScheduleRunnerPlugin

@nicopap
Copy link
Contributor

nicopap commented May 10, 2023

The docs.rs links in the doc string is a bit of an anti-pattern. But they actually make sense in this specific situation, and they were already this way before.

@SpecificProtagonist SpecificProtagonist changed the title Merged ScheduleRunnerSettings into ScheduleRunnerPlugin Merge ScheduleRunnerSettings into ScheduleRunnerPlugin May 10, 2023
Testare
Testare reviewed May 10, 2023
View reviewed changes
examples/app/headless.rs Outdated Show resolved Hide resolved
@Testare
Copy link
Contributor

Testare commented May 10, 2023

Thank you for doing this!

@nicopap nicopap added C-Code-Quality A section of code that is hard to understand or change A-App Bevy apps and plugins C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide labels May 10, 2023
Testare
Testare approved these changes May 10, 2023
View reviewed changes
Copy link
Contributor

@Testare Testare left a comment

Choose a reason for hiding this comment

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

LGTM

@nicopap nicopap 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 May 10, 2023
james7132
james7132 approved these changes May 10, 2023
View reviewed changes
Copy link
Member

@james7132 james7132 left a comment

Choose a reason for hiding this comment

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

I agree with @nicopap that it's an anti-pattern, but the current split of crates makes links like those hard or impossible to manage without it. It's also not a regression per se, so I don't want us to block on this.

@james7132 james7132 added this pull request to the merge queue May 10, 2023
Merged via the queue into bevyengine:main with commit 86aaad7 May 10, 2023
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@james7132 james7132 james7132 approved these changes

@Testare Testare Testare approved these changes

@nicopap nicopap nicopap approved these changes

Assignees
No one assigned
Labels
A-App Bevy apps and plugins C-Breaking-Change A breaking change to Bevy's public API that needs to be noted in a migration guide C-Code-Quality A section of code that is hard to understand or change 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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@SpecificProtagonist @nicopap @Testare @james7132