docs: clarify how to create windows from ActiveEventLoop#4572
Open
tatakaisun wants to merge 1 commit into
Open
docs: clarify how to create windows from ActiveEventLoop#4572tatakaisun wants to merge 1 commit into
tatakaisun wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #3877.
Reproduction
The crate-level "Building windows" documentation currently shows creating an
EventLoop, then immediately says to create aWindowwithcreate_window.That skips the step where users obtain an
ActiveEventLoop, which is the valuethat actually exposes
create_window.Why this is a small fix
The existing example already creates the window from an
ApplicationHandlercallback. This PR only adds the missing explanation:
EventLoop::run_app()launches the loop and passes an
ActiveEventLoopto the handler callbacks, andthat active event loop should be used to create the window.
Backward compatibility
This is documentation-only. No API, behavior, examples, or runtime code are
changed.
Checks
cargo check -p winitpassedcargo test -p winit --docpassedcargo fmt --checkfails due to existing formatting / rustfmt configuration unrelated to this docs-only change