Return a Result from Taffy::remove #106
Merged
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
Deciding to unwrap in the tests, so that the tests fail if the remove fails.
alice-i-cecile
added
usability
alice-i-cecile
approved these changes
Jun 9, 2022
sixfold-origami
changed the title
Weibye
approved these changes
Jun 9, 2022
|
PR title should be updated to "Return a Result from Taffy::remove" |
alice-i-cecile
changed the title
|
@sixfold I broke the merge, sorry! Are you able to fix this? |
Probably. I'll take a look. |
auto-merge was automatically disabled
June 11, 2022 13:20
Head branch was pushed to by a user without write access
|
Should be all fixed now :) |
jkelleyrtp
pushed a commit
that referenced
this pull request
Oct 10, 2022
* Return a result from Sprawl::remove * Update `RELEASES.md` * Fix clippy error, fix compiler warnings Deciding to unwrap in the tests, so that the tests fail if the remove fails. * Run cargo fmt * Move release note to new "0.2.0" section * Add blank lines to satiate the Markdown Lint gods * Remove pointless let _ = call * Fix merge error Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
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.
Objective
Fixes: #102
Returning a
Resulthere has two nice benefits for users:Sprawl::remove_childandSprawl::remove_child_at_indexContext
The original issue suggests using an
Option<Id>for this, but I decided to useResult<usize, Error>for three reasons:Sprawl::find_nodereturns aResult, and it would be good to propagate that error up.NodeIdis only used internally, so the public API should use the underlyingusizeI also updated the docstring, as returning a
usizewithout any additional context could be confusing.Feedback wanted
This is a breaking change. I understand I'm supposed to updateResolvedRELEASES.md, but the exact details on this aren't super clear. Is what I wrote acceptable?