From cc9040009ab0d5aa43101f507c8b810b6bbea7d0 Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Sun, 29 Nov 2020 01:25:37 +0100 Subject: [PATCH] CHANGELOG: Explain what sealing means Also, remove the emoji. Even though they're cute, they're hard to recognize and understand by non-native English speakers and by visually impaired people. --- CHANGELOG.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d47ab64d..67134bbd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -39,14 +39,19 @@ ### Breaking Changes - Remove `Spi::read` in favor of `transfer_split_uneven` ([#190]). -- Seal the `timer::Instance` trait ([#214]). - Make GPIOs start in a `Disconnected` state instead of `Input` ([#220] [#245]). -- 🦭 all `Instance` traits ([#255]). -- 🦭 PPI traits ([#259]). +- Seal¹ the `timer::Instance` trait ([#214]). +- Seal¹ all `Instance` traits ([#255]). +- Seal¹ PPI traits ([#259]). - Various TWIM fixes and improvements - removes automatic transfer splitting ([#242]). - Remove typestate from RTC to make it easier to use ([#252]). - Also return owned `Pins` from `Usart::free()` ([#261]). +¹ _A trait can be sealed by making a private trait a supertrait. That way, no + downstream crates can implement it (since they can't name the supertrait). + This is just to make sure the trait isn't implemented by types that shouldn't + implement it._ + ### Internal Improvements - Utilize [`cargo-xtask`] to simplify CI and the release process ([#207] [#210]).