Improve docs for WorldQuery
#17654
Merged
Improve docs for WorldQuery
#17654
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alice-i-cecile
requested review from
chescock,
SpecificProtagonist and
cBournhonesque
alice-i-cecile
added
C-Docs
bushrat011899
approved these changes
Feb 3, 2025
james-j-obrien
approved these changes
Feb 3, 2025
chescock
approved these changes
Feb 3, 2025
| /// For `QueryFilter` this will be either `()`, or a `bool` indicating whether the entity should be included | ||
| /// or a tuple of such things. | ||
| /// Archetypal query filters (like `With`) set this to `()`, as the filtering is done by selecting the archetypes to iterate over, |
There was a problem hiding this comment.
It's kind of weird that QueryFilters even have an Item. I think it's mostly because they used to be a single trait, and the change to separate them tried to minimize changes.
Would be more clear if we moved Item and fetch from WorldQuery to QueryData, and then did all the filtering in filter_fetch? (Not in this PR, of course.) It doesn't look like fetch is ever called on a QueryFilter outside its own implementation, so that might work.
There was a problem hiding this comment.
Spun out into #17662. Fully agree.
Co-authored-by: James O'Brien <[email protected]>
alice-i-cecile
requested review from
james-j-obrien,
cBournhonesque,
Carter0,
chescock and
bushrat011899
alice-i-cecile
removed
the
S-Needs-Review
alice-i-cecile
added
the
S-Ready-For-Final-Review
|
Really excellent suggestions; thank you all. Waiting on one re-review before merging. |
bushrat011899
approved these changes
Feb 3, 2025
chescock
approved these changes
Feb 3, 2025
mrchantey
pushed a commit
to mrchantey/bevy
that referenced
this pull request
Feb 4, 2025
# Objective While working on bevyengine#17649, I found the docs for `WorldQuery` and the related traits frustratingly vague. ## Solution Clarify them and add some more tangible advice. Also fix a copy-pasted typo in related comments. --------- Co-authored-by: James O'Brien <[email protected]>
joshua-holmes
pushed a commit
to joshua-holmes/bevy
that referenced
this pull request
Feb 5, 2025
# Objective While working on bevyengine#17649, I found the docs for `WorldQuery` and the related traits frustratingly vague. ## Solution Clarify them and add some more tangible advice. Also fix a copy-pasted typo in related comments. --------- Co-authored-by: James O'Brien <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
While working on #17649, I found the docs for
WorldQueryand the related traits frustratingly vague.Solution
Clarify them and add some more tangible advice.
Also fix a copy-pasted typo in related comments.