Updated CHANGELOG.md with dedicated breaking changes section

This commit is contained in:
Alexandre Bury 2019-03-03 19:41:27 -08:00
parent 9cd4f21963
commit ed7fca5b54

View File

@ -2,16 +2,19 @@
## Next version (0.11.0) ## Next version (0.11.0)
### API updates ### Breaking changes
- Breaking change: `Finder::find_id()` is renamed to `call_on_id()`, and a proper - `Cursive::{ncurses, pancurses, termion}` now return
`find_id()` was added instead.
- Breaking change: replaced `set_fps(i32)` with `set_autorefresh(bool)`
- Breaking change: updated the Backend trait for a simpler input system
- Breaking change: `Cursive::{ncurses, pancurses, termion}` now return
`io::Result<Self>` instead of panicking. `Cursive::default()` still unwraps. `io::Result<Self>` instead of panicking. `Cursive::default()` still unwraps.
- Also added `Cursive::try_new` for failible backends. - Also added `Cursive::try_new` for failible backends.
- Updated to Rust 2018 (now requires rustc > 1.31) - Replaced `set_fps(i32)` with `set_autorefresh(bool)`
- `Finder::find_id()` is renamed to `call_on_id()`, and a proper
`find_id()` was added instead.
- Updated the Backend trait for a simpler input system
- Updated to Rust 2018 edition (now requires rustc > 1.31)
### API updates
- Add a logging implementation (`logger::init()`) and a `DebugConsole` - Add a logging implementation (`logger::init()`) and a `DebugConsole`
(`cursive::toggle_debug_console()`) (`cursive::toggle_debug_console()`)
- Add user-data to Cursive. - Add user-data to Cursive.