You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: crates/bevy_ecs/src/system/query.rs
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -235,13 +235,13 @@ use std::{any::TypeId, borrow::Borrow, fmt::Debug};
235
235
///
236
236
/// |Query methods|Effect|
237
237
/// |:---:|---|
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.|
245
245
///
246
246
/// There are two methods for each type of query operation: immutable and mutable (ending with `_mut`).
247
247
/// 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};
0 commit comments