Skip to content

Commit

Permalink
Merge pull request #271 from dbrgn/changelog-sealing-note
Browse files Browse the repository at this point in the history
CHANGELOG: Explain what sealing means
  • Loading branch information
jonas-schievink authored Nov 29, 2020
2 parents 19963df + cc90400 commit ce7b3a9
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<Floating>` ([#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]).
Expand Down

0 comments on commit ce7b3a9

Please sign in to comment.