Mention in docs about the query iteration order and result uniqueness. #12400
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
james7132
added
C-Docs
james7132
changed the title
afonsolage
approved these changes
Mar 11, 2024
pablo-lua
reviewed
Mar 11, 2024
| @@ -730,6 +730,9 @@ impl<D: QueryData, F: QueryFilter> QueryState<D, F> { | |||
| } | |||
|
|
|||
| /// Returns an [`Iterator`] over the query results for the given [`World`]. | |||
| /// | |||
| /// This iterator is always guaranteed to return results from each matching entity once and only once. | |||
| /// Iteration order is not guaranteed. | |||
There was a problem hiding this comment.
I was curious about this: Is the iteration order random at some length? Or do it choose as first some archetypes rather than others?
There was a problem hiding this comment.
Right now it's in archetype ID order, but adding and removing components moves entities around both on tables and archetypes.
The exact iteration order should not be mentioned as it's not guaranteed in any form and subject to change at any time.
pablo-lua
approved these changes
Mar 11, 2024
mockersf
approved these changes
Mar 11, 2024
mockersf
added
the
S-Ready-For-Final-Review
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
Fix #10876. Improve
QueryandQueryState's docs.Solution
Explicitly denote that Query is always guaranteed to return results from all matching entities once and only once for each entity, and that iteration order is not guaranteed in any way.