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

Renamed members of ParamWarnPolicy to reflect new behaviour. #17311

Merged
merged 1 commit into from
Jan 12, 2025

Conversation

AlephCubed
Copy link
Contributor

@AlephCubed AlephCubed commented Jan 11, 2025

  • Once renamed to Warn.
  • param_warn_once() renamed to warn_param_missing().
  • never_param_warn() renamed to ignore_param_missing().

Also includes changes to the documentation of the above methods.

Fixes #17262.

Migration Guide

  • ParamWarnPolicy::Once has been renamed to ParamWarnPolicy::Warn.
  • ParamWarnPolicy::param_warn_once has been renamed to ParamWarnPolicy::warn_param_missing.
  • ParamWarnPolicy::never_param_warn has been renamed to ParamWarnPolicy::ignore_param_missing.

- `Once` renamed to `Warn`.
- `param_warn_once()` renamed to `warn_param_missing()`.
- `never_param_warn()` renamed to `ignore_param_missing`.
@BenjaminBrienen BenjaminBrienen added D-Trivial Nice and easy! A great choice to get started with Bevy A-ECS Entities, components, systems, and events C-Usability A targeted 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 labels Jan 11, 2025
@alice-i-cecile alice-i-cecile added the M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide label Jan 12, 2025
Copy link
Contributor

It looks like your PR is a breaking change, but you didn't provide a migration guide.

Could you add some context on what users should update when this change get released in a new version of Bevy?
It will be used to help writing the migration guide for the version. Putting it after a ## Migration Guide will help it get automatically picked up by our tooling.

@alice-i-cecile
Copy link
Member

I'll merge this once there's a migration guide :)

@AlephCubed
Copy link
Contributor Author

Added :)

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 12, 2025
Merged via the queue into bevyengine:main with commit e808fbe Jan 12, 2025
34 checks passed
@AlephCubed AlephCubed deleted the never-param-warn branch January 12, 2025 06:41
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-Usability A targeted quality-of-life change that makes Bevy easier to use D-Trivial Nice and easy! A great choice to get started with Bevy M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide 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.

Rename never_param_warn into something like ignore_param_missing
3 participants