bevy/crates/bevy_ecs/src
Daniel Burrows d4ffa3f490 Document what Config is and how to use it. (#2185)
While trying to figure out how to implement a `SystemParam`, I spent a
long time looking for a feature that would do exactly what `Config`
does.  I ignored it at first because all the examples I could find used
`()` and I couldn't see a way to modify it.

This is documented in other places, but `Config` is a logical place to
include some breadcrumbs.  I've added some text that gives a brief
overview of what `Config` is for, and links to the existing docs on
`FunctionSystem::config` for more details.

This would have saved me from embarrassing myself by filing https://github.com/bevyengine/bevy/issues/2178.

Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2021-05-18 00:10:18 +00:00
..
component Improve bevy_ecs query docs (#1935) 2021-04-22 19:09:09 +00:00
entity Improve bevy_ecs query docs (#1935) 2021-04-22 19:09:09 +00:00
query Add a method iter_combinations on query to iterate over combinations of query results (#1763) 2021-05-17 23:33:47 +00:00
schedule Improve legibility of RunOnce::run_unsafe param (#2181) 2021-05-18 00:10:17 +00:00
storage [bevy_ecs] Cleanup SparseSetIndex impls (#2099) 2021-05-07 00:46:54 +00:00
system Document what Config is and how to use it. (#2185) 2021-05-18 00:10:18 +00:00
world Impl AsRef+AsMut for Res, ResMut, and Mut (#2189) 2021-05-17 23:07:19 +00:00
archetype.rs Fix sparse insert (#1748) 2021-03-25 05:56:00 +00:00
bundle.rs Allows a number of clippy lints and fixes 2 (#1999) 2021-05-14 20:37:32 +00:00
event.rs Improve bevy_ecs query docs (#1935) 2021-04-22 19:09:09 +00:00
lib.rs Hide re-exported docs (#1985) 2021-04-27 18:29:33 +00:00
reflect.rs Reliable change detection (#1471) 2021-03-19 17:53:26 +00:00