Skip to content

Commit ce7b3a9

Browse files
Merge pull request #271 from dbrgn/changelog-sealing-note
CHANGELOG: Explain what sealing means
2 parents 19963df + cc90400 commit ce7b3a9

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

CHANGELOG.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,19 @@
3939
### Breaking Changes
4040

4141
- Remove `Spi::read` in favor of `transfer_split_uneven` ([#190]).
42-
- Seal the `timer::Instance` trait ([#214]).
4342
- Make GPIOs start in a `Disconnected` state instead of `Input<Floating>` ([#220] [#245]).
44-
- 🦭 all `Instance` traits ([#255]).
45-
- 🦭 PPI traits ([#259]).
43+
- Seal¹ the `timer::Instance` trait ([#214]).
44+
- Seal¹ all `Instance` traits ([#255]).
45+
- Seal¹ PPI traits ([#259]).
4646
- Various TWIM fixes and improvements - removes automatic transfer splitting ([#242]).
4747
- Remove typestate from RTC to make it easier to use ([#252]).
4848
- Also return owned `Pins` from `Usart::free()` ([#261]).
4949

50+
¹ _A trait can be sealed by making a private trait a supertrait. That way, no
51+
downstream crates can implement it (since they can't name the supertrait).
52+
This is just to make sure the trait isn't implemented by types that shouldn't
53+
implement it._
54+
5055
### Internal Improvements
5156

5257
- Utilize [`cargo-xtask`] to simplify CI and the release process ([#207] [#210]).

0 commit comments

Comments
 (0)