Add doctest example for QueryState to to direct users to World::try_query for easy QueryState construction #22224
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
It's easy for users to stumble across
World::queryorDeferredWorld::querybut then be somewhat mystified as to how one goes about constructing aQueryStatewithout getting into a knife fight with the borrow checker and/or requiring a&mut Worldthey may not have.Solution
Provide users with a practical example that answers this question in a place in the docs they're likely to end up in regardless of which angle they encounter this problem from.
Testing
N/A
Showcase
N/A