Skip to content

Commit 4b5df0f

Browse files
BD103mockersf
authored andcommitted
Fix indentation of bevy/query strict parameter in docs (#18681)
# Objective - The `strict` field of [`BrpQueryParams`](https://dev-docs.bevyengine.org/bevy/remote/builtin_methods/struct.BrpQueryParams.html) was newly added as part of 0.16. - Its documentation in `lib.rs` improperly indents `strict`, making look like its part of [`BrpQueryFilter`](https://dev-docs.bevyengine.org/bevy/remote/builtin_methods/struct.BrpQueryFilter.html): ![image](https://github.com/user-attachments/assets/f49521da-36d3-4d5d-a7ea-f7a44ddaf195) ## Solution - Fix `strict`'s indentation so its clear that it is a field of `BrpQueryParams`, not `BrpQueryFilter`. I would like this to be included in 0.16, since it's a trivial documentation change that fixes an error, but if it needs to be removed from the milestone that's fine. ## Testing Run `cargo doc -p bevy_remote --no-deps` and verify the indentation is fixed. :)
1 parent deba691 commit 4b5df0f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

crates/bevy_remote/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,8 @@
143143
//! on entities in order for them to be included in results.
144144
//! - `without` (optional): An array of fully-qualified type names of components that must *not* be
145145
//! present on entities in order for them to be included in results.
146-
//! - `strict` (optional): A flag to enable strict mode which will fail if any one of the
147-
//! components is not present or can not be reflected. Defaults to false.
146+
//! - `strict` (optional): A flag to enable strict mode which will fail if any one of the components
147+
//! is not present or can not be reflected. Defaults to false.
148148
//!
149149
//! `result`: An array, each of which is an object containing:
150150
//! - `entity`: The ID of a query-matching entity.

0 commit comments

Comments
 (0)