mirror of
https://github.com/bevyengine/bevy
synced 2024-11-25 14:10:19 +00:00
f0c504947c
# Objective See: - https://github.com/bevyengine/bevy/issues/7067#issuecomment-1381982285 - (This does not fully close that issue in my opinion.) - https://discord.com/channels/691052431525675048/1063454009769340989 ## Solution This merge request adds documentation: 1. Alert users to the fact that `App::run()` might never return and code placed after it might never be executed. 2. Makes `winit::WinitSettings::return_from_run` discoverable. 3. Better explains why `winit::WinitSettings::return_from_run` is discouraged and better links to up-stream docs. on that topic. 4. Adds notes to the `app/return_after_run.rs` example which otherwise promotes a feature that carries caveats. Furthermore, w.r.t `winit::WinitSettings::return_from_run`: - Broken links to `winit` docs are fixed. - Links now point to BOTH `EventLoop::run()` and `EventLoopExtRunReturn::run_return()` which are the salient up-stream pages and make more sense, taken together. - Collateral damage: "Supported platforms" heading; disambiguation of "run" → `App::run()`; links. ## Future Work I deliberately structured the "`run()` might not return" section under `App::run()` to allow for alternative patterns (e.g. `AppExit` event, `WindowClosed` event) to be listed or mentioned, beneath it, in the future. |
||
|---|---|---|
| .. | ||
| custom_loop.rs | ||
| drag_and_drop.rs | ||
| empty.rs | ||
| empty_defaults.rs | ||
| headless.rs | ||
| logs.rs | ||
| no_renderer.rs | ||
| plugin.rs | ||
| plugin_group.rs | ||
| return_after_run.rs | ||
| thread_pool_resources.rs | ||
| without_winit.rs | ||