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.
This commit is contained in:
parent
84144c9429
commit
7fd781e670
@ -276,16 +276,10 @@ where
|
||||
}
|
||||
}
|
||||
|
||||
/// Returns an [`Iterator`] over all possible combinations of `K` query results without repetition.
|
||||
/// 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.
|
||||
///
|
||||
/// 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)
|
||||
///
|
||||
/// This can only be called for read-only queries, see [`Self::iter_combinations_mut`] for
|
||||
/// write-queries.
|
||||
#[inline]
|
||||
pub fn iter_manual<'w, 's>(
|
||||
&'s self,
|
||||
|
Loading…
Reference in New Issue
Block a user