Repository navigation
docs(core)!: note that DitherConfig gained the dbs field - #75
Merged
Merged
Conversation
Recommend struct-update syntax (..Default::default()) for DitherConfig, which is resilient to new fields. BREAKING CHANGE: `DitherConfig` has a new public field `dbs` (DBS refinement, added in #71). Code that constructs `DitherConfig` with an exhaustive struct literal must add `dbs: None`, or switch to `..Default::default()`.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
epaper-dithering-coreis published to crates.io. #71 added a public field,DitherConfig::dbs, which breaks any Rust code that constructsDitherConfigby listing every field. This repo's own Python and WASM bindings neededdbs: Noneto compile. The pending release PR (#72) would publish this as 5.1.0, which^5requirements pick up automatically, so downstream builds would break oncargo update.This PR marks the change as breaking so release-please bumps the crate to 6.0.0 and puts a migration note in its changelog.
What
DitherConfig: prefer..Default::default(), which keeps compiling when fields are added.BREAKING CHANGE: DitherConfig has a new public field dbs … must add dbs: None, or switch to ..Default::default().Effect on other packages
epaper-dithering): unaffected; this commit only touchespackages/rust/core. They stay at 6.1.0, which is correct since their API change only adds things.Merge note: if you squash-merge, keep the
BREAKING CHANGE:footer in the squash commit body. With a merge commit it's preserved automatically.