Skip to content

Entitymut doc changes for #24596#24631

Merged
alice-i-cecile merged 3 commits into
bevyengine:mainfrom
MoRusty:entitymut-docs
Jun 17, 2026
Merged

Entitymut doc changes for #24596#24631
alice-i-cecile merged 3 commits into
bevyengine:mainfrom
MoRusty:entitymut-docs

Conversation

@MoRusty

@MoRusty MoRusty commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Objective

Solution

  • Describe the solution used to achieve the objective above.
  • Changed get_components methods that use result instead of option to return the correct type instead of None.
  • Moved safety above example for get/into_components_mut

Testing

  • Did you test these changes? If so, how? Yes, ran "cargo run -p ci -- doc" and tests came back ok
  • Are there any parts that need more testing? Not that I'm aware of.
  • How can other people (reviewers) test your changes? Is there anything specific they need to know? Read the comments and check they are correct. there shouldn't be a fn returning type result that returns None on the fail.
  • If relevant, what platforms did you test these changes on, and are there any important ones you can't test? N/A

@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 ✨

@SpecificProtagonist SpecificProtagonist left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The docs of QueryAccessError should also be updated.

(I've also noticed that the has_conflicts mentioned therein has unclear docs and get_componetns_mut_unchecked technically violates the safety preconditions of WorldQuery::init_fetch, but that's a separate issue).

@SpecificProtagonist SpecificProtagonist added C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-ECS Entities, components, systems, and events S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it labels Jun 15, 2026
@github-project-automation github-project-automation Bot moved this to Needs SME Triage in ECS Jun 15, 2026
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jun 17, 2026
Merged via the queue into bevyengine:main with commit c9787c9 Jun 17, 2026
38 checks passed
@github-project-automation github-project-automation Bot moved this from Needs SME Triage to Done in ECS Jun 17, 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: Done

Development

Successfully merging this pull request may close these issues.

Docs for EntityWorldMut::get_components_mut_unchecked are incorrect

4 participants