Skip to content

docs(bevy_ecs): clarify how to configure Res/ResMut validation error …#24315

Open
tylerrussin wants to merge 1 commit into
bevyengine:mainfrom
tylerrussin:main
Open

docs(bevy_ecs): clarify how to configure Res/ResMut validation error …#24315
tylerrussin wants to merge 1 commit into
bevyengine:mainfrom
tylerrussin:main

Conversation

@tylerrussin
Copy link
Copy Markdown

Objective

Fixes #23770

The documentation for Res, ResMut, NonSend, and NonSendMut stated
that validation failures "can be configured to do nothing or warn once"
but never explained how to actually configure it.

Solution

Replaced the misleading sentence with accurate information pointing users
to If<T> for silently skipping the system, and clarified that
Option<T> is for when you want to handle the missing resource yourself.

Testing

No testing is required. These are documentation-only changes.

@github-actions
Copy link
Copy Markdown
Contributor

Welcome, new contributor!

Please make sure you've read our contributing guide, as well as our policy regarding AI usage, and we look forward to reviewing your pull request shortly ✨

@kfc35 kfc35 added C-Docs An addition or correction to our documentation S-Needs-Review Needs reviewer attention (from anyone!) to move forward A-ECS Entities, components, systems, and events labels May 15, 2026
@github-project-automation github-project-automation Bot moved this to Needs SME Triage in ECS May 15, 2026
@kfc35 kfc35 added S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it D-Trivial Nice and easy! A great choice to get started with Bevy and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels May 15, 2026
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-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

Status: Needs SME Triage

Development

Successfully merging this pull request may close these issues.

Res documentation mention how to configure error response.

3 participants