38e6f9ad84
This commit does not represent a release and only synchronizes CHANGELOG from the latest release.
52 lines
1.4 KiB
Markdown
52 lines
1.4 KiB
Markdown
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
|
|
|
The sections should follow the order `Added`, `Changed`, `Deprecated`,
|
|
`Removed`, and `Fixed`.
|
|
|
|
Platform specific changed should be added to the end of the section and grouped
|
|
by platform name. Common API additions should have `, implemented` at the end
|
|
for platforms where the API was initially implemented. See the following example
|
|
on how to add them:
|
|
|
|
```md
|
|
### Added
|
|
|
|
- Add `Window::turbo()`, implemented on X11, Wayland, and Web.
|
|
- On X11, add `Window::some_rare_api`.
|
|
- On X11, add `Window::even_more_rare_api`.
|
|
- On Wayland, add `Window::common_api`.
|
|
- On Windows, add `Window::some_rare_api`.
|
|
```
|
|
|
|
When the change requires non-trivial amount of work for users to comply
|
|
with it, the migration guide should be added below the entry, like:
|
|
|
|
```md
|
|
- Deprecate `Window` creation outside of `EventLoop::run`
|
|
|
|
This was done to simply migration in the future. Consider the
|
|
following code:
|
|
|
|
// Code snippet.
|
|
|
|
To migrate it we should do X, Y, and then Z, for example:
|
|
|
|
// Code snippet.
|
|
|
|
```
|
|
|
|
The migration guide could reference other migration examples in the current
|
|
changelog entry.
|
|
|
|
## Unreleased
|
|
|
|
### Changed
|
|
|
|
- On Web, let events wake up event loop immediately when using `ControlFlow::Poll`.
|
|
- Bump MSRV from `1.70` to `1.73`.
|
|
|
|
### Removed
|
|
|
|
- Remove `EventLoop::run`.
|
|
- Remove `EventLoopExtRunOnDemand::run_on_demand`.
|
|
- Remove `EventLoopExtPumpEvents::pump_events`.
|