Skip to content

Commit 264195e

Browse files
authored
replace parens with square brackets when referencing _mut on Query docs #9200 (#9223)
# Objective Fixes #9200 Switches ()'s to []'s when talking about the optional `_mut` suffix in the ECS Query Struct page to have more idiomatic docs. ## Solution Replace `()` with `[]` in appropriate doc pages.
1 parent 9b92de9 commit 264195e

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

crates/bevy_ecs/src/system/query.rs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -235,13 +235,13 @@ use std::{any::TypeId, borrow::Borrow, fmt::Debug};
235235
///
236236
/// |Query methods|Effect|
237237
/// |:---:|---|
238-
/// |[`iter`]\([`_mut`][`iter_mut`])|Returns an iterator over all query items.|
239-
/// |[`for_each`]\([`_mut`][`for_each_mut`]),<br>[`par_iter`]\([`_mut`][`par_iter_mut`])|Runs a specified function for each query item.|
240-
/// |[`iter_many`]\([`_mut`][`iter_many_mut`])|Iterates or runs a specified function over query items generated by a list of entities.|
241-
/// |[`iter_combinations`]\([`_mut`][`iter_combinations_mut`])|Returns an iterator over all combinations of a specified number of query items.|
242-
/// |[`get`]\([`_mut`][`get_mut`])|Returns the query item for the specified entity.|
243-
/// |[`many`]\([`_mut`][`many_mut`]),<br>[`get_many`]\([`_mut`][`get_many_mut`])|Returns the query items for the specified entities.|
244-
/// |[`single`]\([`_mut`][`single_mut`]),<br>[`get_single`]\([`_mut`][`get_single_mut`])|Returns the query item while verifying that there aren't others.|
238+
/// |[`iter`]\[[`_mut`][`iter_mut`]]|Returns an iterator over all query items.|
239+
/// |[`for_each`]\[[`_mut`][`for_each_mut`]],<br>[`par_iter`]\[[`_mut`][`par_iter_mut`]]|Runs a specified function for each query item.|
240+
/// |[`iter_many`]\[[`_mut`][`iter_many_mut`]]|Iterates or runs a specified function over query items generated by a list of entities.|
241+
/// |[`iter_combinations`]\[[`_mut`][`iter_combinations_mut`]]|Returns an iterator over all combinations of a specified number of query items.|
242+
/// |[`get`]\[[`_mut`][`get_mut`]]|Returns the query item for the specified entity.|
243+
/// |[`many`]\[[`_mut`][`many_mut`]],<br>[`get_many`]\[[`_mut`][`get_many_mut`]]|Returns the query items for the specified entities.|
244+
/// |[`single`]\[[`_mut`][`single_mut`]],<br>[`get_single`]\[[`_mut`][`get_single_mut`]]|Returns the query item while verifying that there aren't others.|
245245
///
246246
/// There are two methods for each type of query operation: immutable and mutable (ending with `_mut`).
247247
/// When using immutable methods, the query items returned are of type [`ROQueryItem`], a read-only version of the query item.
@@ -271,14 +271,14 @@ use std::{any::TypeId, borrow::Borrow, fmt::Debug};
271271
///
272272
/// |Query operation|Computational complexity|
273273
/// |:---:|:---:|
274-
/// |[`iter`]\([`_mut`][`iter_mut`])|O(n)|
275-
/// |[`for_each`]\([`_mut`][`for_each_mut`]),<br>[`par_iter`]\([`_mut`][`par_iter_mut`])|O(n)|
276-
/// |[`iter_many`]\([`_mut`][`iter_many_mut`])|O(k)|
277-
/// |[`iter_combinations`]\([`_mut`][`iter_combinations_mut`])|O(<sub>n</sub>C<sub>r</sub>)|
278-
/// |[`get`]\([`_mut`][`get_mut`])|O(1)|
274+
/// |[`iter`]\[[`_mut`][`iter_mut`]]|O(n)|
275+
/// |[`for_each`]\[[`_mut`][`for_each_mut`]],<br>[`par_iter`]\[[`_mut`][`par_iter_mut`]]|O(n)|
276+
/// |[`iter_many`]\[[`_mut`][`iter_many_mut`]]|O(k)|
277+
/// |[`iter_combinations`]\[[`_mut`][`iter_combinations_mut`]]|O(<sub>n</sub>C<sub>r</sub>)|
278+
/// |[`get`]\[[`_mut`][`get_mut`]]|O(1)|
279279
/// |([`get_`][`get_many`])[`many`]|O(k)|
280280
/// |([`get_`][`get_many_mut`])[`many_mut`]|O(k<sup>2</sup>)|
281-
/// |[`single`]\([`_mut`][`single_mut`]),<br>[`get_single`]\([`_mut`][`get_single_mut`])|O(a)|
281+
/// |[`single`]\[[`_mut`][`single_mut`]],<br>[`get_single`]\[[`_mut`][`get_single_mut`]]|O(a)|
282282
/// |Archetype based filtering ([`With`], [`Without`], [`Or`])|O(a)|
283283
/// |Change detection filtering ([`Added`], [`Changed`])|O(a + n)|
284284
///

0 commit comments

Comments
 (0)