bevy/crates/bevy_window/src
Jordan Ellis Coppard 04ca832dfe
improve documentation relating to WindowPlugin and Window (#9173)
- attempt to clarify with better docstrings the default behaviour of
WindowPlugin and the component type it accepts.

# Objective

- I'm new to Rust and Bevy, I got a bit confused about how to customise
some window parameters (title, height, width etc) and while the docs do
show the struct code for that field `Option<Window>` I was a bit of a
doofus and skipped that to read the docstring entry for `primary_window`
and then the `Window` component directly which aren't linked together.
This is a minor improvement which I think will help in-case others, like
me, have a doofus moment.

---------

Co-authored-by: Sélène Amanita <134181069+Selene-Amanita@users.noreply.github.com>
2023-07-30 15:46:16 +00:00
..
cursor.rs bevy_reflect: FromReflect Ergonomics Implementation (#6056) 2023-06-29 01:31:34 +00:00
event.rs Expose WindowDestroyed events (#9016) 2023-07-04 21:50:53 +00:00
lib.rs improve documentation relating to WindowPlugin and Window (#9173) 2023-07-30 15:46:16 +00:00
raw_handle.rs Windows as Entities (#5589) 2023-01-19 00:38:28 +00:00
system.rs Non-breaking change* from UK spellings to US (#8291) 2023-04-08 16:22:46 +00:00
window.rs improve documentation relating to WindowPlugin and Window (#9173) 2023-07-30 15:46:16 +00:00