perf(rect)!: Rect::inner takes Margin directly instead of reference
#1008
Conversation
This file contains 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
EdJoPaTo
requested review from
orhun,
mindoodoo,
sayanarijit,
joshka,
kdheepak and
Valentin271
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1008 +/- ##
=====================================
Coverage 94.2% 94.2%
=====================================
Files 60 60
Lines 14630 14630
=====================================
Hits 13790 13790
Misses 840 840 ☔ View full report in Codecov by Sentry. |
joshka
changed the title
github-actions
bot
added
the
Type: Breaking Change
joshka
requested changes
Mar 31, 2024
There was a problem hiding this comment.
LGTM as a breaking change
- Update the PR message to be changelog focused (e.g. tell the user how they need to change their apps.) Something like "Rect::inner() now takes Margin instead of &Margin"
- Add the info to the breaking change doc
- Add the breaking change section of the commit (https://www.conventionalcommits.org/)
- Make sure there's a small example of how to fix the change in both places (this is overkill for such a small change, but doing it consistently makes it easy for users upgrading to search for this sort of thing easily)
Hold off merging until 0.27.0 release is ready to go after 0.26.2
EdJoPaTo
changed the title
EdJoPaTo
changed the title
Rect::inner takes Margin directly instead of reference
joshka
approved these changes
Apr 10, 2024
joshka
added
the
Status: Do Not Merge
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
|
BTW, I expect this will probably break a lot of projects (520 results): |
|
I'd like for this change to be made because it'll make it consistent with a future feature like: #931 |
Sounds like we should break both things at the same time to avoid double breaks. |
Also, adds `Rect::ZERO` and `Rect::inner` is now `const`. BREAKING CHANGE: `Margin` needs to be passed without reference now.
Conflicts: src/widgets/canvas/rectangle.rs
joshka
approved these changes
May 23, 2024
joshka
removed
the
Status: Do Not Merge
This comment was marked as outdated.
This comment was marked as outdated.
Conflicts: BREAKING-CHANGES.md
joshka
pushed a commit
to erak/ratatui
that referenced
this pull request
Oct 14, 2024
…ce (ratatui#1008) BREAKING CHANGE: Margin needs to be passed without reference now. ```diff -let area = area.inner(&Margin { +let area = area.inner(Margin { vertical: 0, horizontal: 2, }); ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
BREAKING CHANGE: Margin needs to be passed without reference now.