bevy/crates/bevy_ecs/src/system
theotherphil 2bda628ecf
Clarify docs for transmute_lens functions (#19233)
# Objective

Make the restrictions of `transmute_lens` and related functions clearer.

Related issue: https://github.com/bevyengine/bevy/issues/12156
Related PR: https://github.com/bevyengine/bevy/pull/12157

## Solution

* Make it clearer that the set of returned entities is a subset of those
from the original query
* Move description of read/write/required access to a table
* Reference the new table in `transmute_lens` docs from the other
`transmute_lens*` functions

## Testing

cargo doc --open locally to check this render correctly

---------

Co-authored-by: Chris Russell <8494645+chescock@users.noreply.github.com>
2025-06-09 19:10:59 +00:00
..
commands Remove ArchetypeComponentId and archetype_component_access (#19143) 2025-05-27 19:04:32 +00:00
adapter_system.rs Unify system state (#19506) 2025-06-08 18:18:43 +00:00
builder.rs bevyengine.org -> bevy.org (#19503) 2025-06-05 23:09:28 +00:00
combinator.rs Unify system state (#19506) 2025-06-08 18:18:43 +00:00
exclusive_function_system.rs Unify system state (#19506) 2025-06-08 18:18:43 +00:00
exclusive_system_param.rs refactor(utils): move SyncCell and SyncUnsafeCell to bevy_platform (#19305) 2025-05-27 04:57:26 +00:00
function_system.rs Unify system state (#19506) 2025-06-08 18:18:43 +00:00
input.rs bevy_ecs: Apply #![warn(clippy::allow_attributes, clippy::allow_attributes_without_reason)] (#17335) 2025-01-14 21:37:41 +00:00
mod.rs bevyengine.org -> bevy.org (#19503) 2025-06-05 23:09:28 +00:00
observer_system.rs Unify system state (#19506) 2025-06-08 18:18:43 +00:00
query.rs Clarify docs for transmute_lens functions (#19233) 2025-06-09 19:10:59 +00:00
schedule_system.rs Unify system state (#19506) 2025-06-08 18:18:43 +00:00
system_name.rs Remove Implicit std Prelude from no_std Crates (#17086) 2025-01-03 01:58:43 +00:00
system_param.rs bevyengine.org -> bevy.org (#19503) 2025-06-05 23:09:28 +00:00
system_registry.rs Mention Option and When in the error message for a failing system parameter (#19490) 2025-06-04 16:39:54 +00:00
system.rs Unify system state (#19506) 2025-06-08 18:18:43 +00:00