rust-windowing / rust-windowing/winit
Document whether ControlFlow::WaitUntil(deadline_in_past) handles or drops event
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 6.2k
- Forks
- 1.3k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 9
Description
The docs for https://docs.rs/winit/latest/winit/event_loop/enum.ControlFlow.html#variant.WaitUntil say:
When the current loop iteration finishes, suspend the thread until either another event arrives or the given time is reached.
These docs don't clearly state whether, if we pass an instant to WaitUntil that is in the past, that event gets handled or dropped. Could you make "or the given time is reached" a little more clear. Thanks!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the ControlFlow::WaitUntil variant documentation at the linked docs.rs page and check the surrounding event-loop documentation for the behavior of a deadline that has already passed. Update the wording to state clearly whether an event is handled or dropped in that case; the documentation should remove this ambiguity.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100