From 7fd781e6703cc229ec5dae46ef9cc96ea6e7e52a Mon Sep 17 00:00:00 2001 From: Nicholas French <32023353+L-french@users.noreply.github.com> Date: Thu, 13 Jan 2022 01:50:54 +0000 Subject: [PATCH] Fix documentation for QueryState::iter_manual (#3644) # Objective - Fixes #3616 ## Solution - As described in the issue, documentation for `iter_manual` was copied from `iter_combinations` and did not reflect the behavior of the method. I've pulled some information from #2351 to create a more accurate description. --- crates/bevy_ecs/src/query/state.rs | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/crates/bevy_ecs/src/query/state.rs b/crates/bevy_ecs/src/query/state.rs index 33d2ecab4fe7f..c13b0dc75700b 100644 --- a/crates/bevy_ecs/src/query/state.rs +++ b/crates/bevy_ecs/src/query/state.rs @@ -276,16 +276,10 @@ where } } - /// Returns an [`Iterator`] over all possible combinations of `K` query results without repetition. - /// This can only be called for read-only queries. - /// - /// For permutations of size K of query returning N results, you will get: - /// - if K == N: one permutation of all query results - /// - if K < N: all possible K-sized combinations of query results, without repetition - /// - if K > N: empty set (no K-sized combinations exist) + /// Returns an [`Iterator`] over the query results for the given [`World`] without updating the query's archetypes. + /// Archetypes must be manually updated before by using [`Self::update_archetypes`]. /// - /// This can only be called for read-only queries, see [`Self::iter_combinations_mut`] for - /// write-queries. + /// This can only be called for read-only queries. #[inline] pub fn iter_manual<'w, 's>( &'s self,