forestia/bevy
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix indentation of bevy/query strict parameter in docs (#18681)

Browse Source 
# 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. :)
This commit is contained in:
BD103 2025-04-02 13:33:02 -04:00 committed by GitHub
parent 6fc31bc623
commit 746b593833
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
crates/bevy_remote/src/lib.rs
View File

@ -143,8 +143,8 @@
//! on entities in order for them to be included in results. //! on entities in order for them to be included in results.
//! - `without` (optional): An array of fully-qualified type names of components that must *not* be //! - `without` (optional): An array of fully-qualified type names of components that must *not* be
//! present on entities in order for them to be included in results. //! present on entities in order for them to be included in results.
//! - `strict` (optional): A flag to enable strict mode which will fail if any one of the //! - `strict` (optional): A flag to enable strict mode which will fail if any one of the components
//! components is not present or can not be reflected. Defaults to false. //! is not present or can not be reflected. Defaults to false.
//! //!
//! `result`: An array, each of which is an object containing: //! `result`: An array, each of which is an object containing:
//! - `entity`: The ID of a query-matching entity. //! - `entity`: The ID of a query-matching entity.