RefCell: document panics in Clone, PartialEq, PartialOrd, Ord. #48365
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
Centril
added
C-enhancement
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
Re-assigning to a T-doc member =) |
|
@steveklabnik ping from the release team! |
frewsxcv
reviewed
Feb 27, 2018
src/libcore/cell.rs
Outdated
| @@ -880,6 +883,9 @@ impl<T:Default> Default for RefCell<T> { | |||
|
|
|||
| #[stable(feature = "rust1", since = "1.0.0")] | |||
| impl<T: ?Sized + PartialEq> PartialEq for RefCell<T> { | |||
| /// # Panics | |||
| /// | |||
| /// Panics if the value is currently mutably borrowed. | |||
There was a problem hiding this comment.
For the functions that take an other like this one, what do you think about using this wording:
Panics if the value in either
RefCellis currently borrowed.
This wording is taken from RefCell::swap
There was a problem hiding this comment.
Sounds like a great improvement 👍
steveklabnik
approved these changes
Feb 27, 2018
There was a problem hiding this comment.
r=me after changing to @frewsxcv 's wording; consistency is important and i think it's slightly clearer. Thanks so much for this PR!
|
@steveklabnik: Will do in a jiffy =) |
|
And fixed. |
|
@bors r+ rollup thanks! |
|
📌 Commit f8ebb3f has been approved by |
bors
added
S-waiting-on-bors
kennytm
added a commit
to kennytm/rust
that referenced
this pull request
Feb 28, 2018
…s, r=frewsxcv RefCell: document panics in Clone, PartialEq, PartialOrd, Ord. This fixes rust-lang#47400 by adding: ```rust /// # Panics /// /// Panics if the value is currently mutably borrowed. ``` to said impls. They may panic since they call `.borrow()`.
bors
added a commit
that referenced
this pull request
Feb 28, 2018
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.
This fixes #47400 by adding:
to said impls. They may panic since they call
.borrow().