tock-cells/OptionalCell: rename get-method to extract #2533
Conversation
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
As an OptionalCell is designed to look like a Cell which can also be empty, the get method as currently implemented does not match the expected behavior (as it will return an `Option<T>` instead of a `T`). Furthermore, as `OptionalCell::set` takes simply a `T` (not wrapped in an `Option`), `get` should not return an `Option<T>`. Accordingly, this commit renames the `OptionalCell::get` method to `extract`, to distinguish it from the `Cell::get` method. Fixes: a845aa8 ("tock-cells/OptionalCell: add get-method...") Suggested-by: Brad Campbell <[email protected]> Signed-off-by: Leon Schuermann <[email protected]>
hudson-ayers
approved these changes
Apr 13, 2021
alistair23
approved these changes
Apr 13, 2021
ppannuto
approved these changes
Apr 14, 2021
bradjc
approved these changes
Apr 14, 2021
|
bors r+ |
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.
Pull Request Overview
As an OptionalCell is designed to look like a Cell which can also be empty, the get method as currently implemented does not match the expected behavior (as it will return an
Option<T>instead of aT). Furthermore, asOptionalCell::settakes simply aT(not wrapped in anOption),getshould not return anOption<T>.Accordingly, this commit renames the
OptionalCell::getmethod toextract, to distinguish it from theCell::getmethod.Fixes: a845aa8 ("tock-cells/OptionalCell: add get-method...") (GitHub PR #2531)
Suggested-by: Brad Campbell [email protected]
Signed-off-by: Leon Schuermann [email protected]
Testing Strategy
This pull request was tested by compiling.
TODO or Help Wanted
A discussion about the right method name to use.
Documentation Updated
Updated the relevant files inno updates are required./docs, orFormatting
make prepush.