bevy/crates
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
..
bevy_app Add inline documentation to bevy code (#1404) 2021-05-06 02:26:54 +00:00
bevy_asset fix diagnostic length for asset count (#2165) 2021-05-14 19:31:36 +00:00
bevy_audio Hide re-exported docs (#1985) 2021-04-27 18:29:33 +00:00
bevy_core use bytemuck crate instead of Byteable trait (#2183) 2021-05-17 22:29:10 +00:00
bevy_derive [bevy_derive] Refactor modules for better error message. (#2059) 2021-05-06 23:45:23 +00:00
bevy_diagnostic fix diagnostic length for asset count (#2165) 2021-05-14 19:31:36 +00:00
bevy_dylib Release 0.5.0 (#1835) 2021-04-06 18:48:48 +00:00
bevy_dynamic_plugin Various cleanups (#2046) 2021-05-01 20:07:06 +00:00
bevy_ecs Document what Config is and how to use it. (#2185) 2021-05-18 00:10:18 +00:00
bevy_gilrs Release 0.5.0 (#1835) 2021-04-06 18:48:48 +00:00
bevy_gltf Update gltf requirement from 0.15.2 to 0.16.0 (#2196) 2021-05-17 18:44:04 +00:00
bevy_input Hide re-exported docs (#1985) 2021-04-27 18:29:33 +00:00
bevy_internal Hide re-exported docs (#1985) 2021-04-27 18:29:33 +00:00
bevy_log Hide re-exported docs (#1985) 2021-04-27 18:29:33 +00:00
bevy_math use bytemuck crate instead of Byteable trait (#2183) 2021-05-17 22:29:10 +00:00
bevy_pbr Fix PBR regression for unlit materials (#2197) 2021-05-17 22:45:07 +00:00
bevy_reflect revert supporting generics for deriving TypeUuid (#2204) 2021-05-17 20:28:50 +00:00
bevy_render use bytemuck crate instead of Byteable trait (#2183) 2021-05-17 22:29:10 +00:00
bevy_scene Hide re-exported docs (#1985) 2021-04-27 18:29:33 +00:00
bevy_sprite use bytemuck crate instead of Byteable trait (#2183) 2021-05-17 22:29:10 +00:00
bevy_tasks Various cleanups (#2046) 2021-05-01 20:07:06 +00:00
bevy_text Allows a number of clippy lints and fixes 2 (#1999) 2021-05-14 20:37:32 +00:00
bevy_transform Move to smallvec v1.6 (#2074) 2021-05-05 19:14:39 +00:00
bevy_ui Allows a number of clippy lints and fixes 2 (#1999) 2021-05-14 20:37:32 +00:00
bevy_utils EnumVariantMeta derive (#1972) 2021-04-21 23:46:54 +00:00
bevy_wgpu Allows a number of clippy lints and fixes 2 (#1999) 2021-05-14 20:37:32 +00:00
bevy_window Adds an alias mouse position -> cursor position (#2038) 2021-04-28 21:26:47 +00:00
bevy_winit Allows a number of clippy lints and fixes 2 (#1999) 2021-05-14 20:37:32 +00:00