Alter std::cell::Cell::get_mut documentation #86397
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
I find this more consistent with RefCell's equivalent method.
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @scottmcm (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
rust-highfive
added
the
S-waiting-on-review
|
r? @JohnTitor @bors r+ rollup |
|
📌 Commit 7cadf7b has been approved by |
bors
added
S-waiting-on-bors
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Jun 19, 2021
Alter std::cell::Cell::get_mut documentation I felt that there was some inconsistency between between Cell and RefCell with regards to their `get_mut` method documentation: `RefCell` flags this method as "unusual" in that it takes `&mut self`, while `Cell` does not. I attempted to flag this in `Cell`s documentation as well, and point to `RefCell`s method in the case where it is required. Find relevant parts of docs and the new version below. The current docs for `Cell::get_mut`: > Returns a mutable reference to the underlying data. This call borrows Cell mutably (at compile-time) which guarantees that we possess the only reference. And `RefCell::get_mut`: > Returns a mutable reference to the underlying data. This call borrows `RefCell` mutably (at compile-time) so there is no need for dynamic checks. However be cautious: this method expects self to be mutable, which is generally not the case when using a `RefCell`. Take a look at the `borrow_mut` method instead if self isn’t mutable. Also, please be aware that this method is only for special circumstances and is usually not what you want. In case of doubt, use `borrow_mut` instead. My attempt to make `Cell::get_mut` clearer: > Returns a mutable reference to the underlying data. This call borrows `Cell` mutably (at compile-time) which guaranteesthat we possess the only reference. However be cautious: this method expects `self` to be mutable, which is generally not the case when using a `Cell`. If you require interior mutability by reference, consider using `RefCell` which provides run-time checked mutable borrows through its `borrow_mut` method.
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jun 19, 2021
Rollup of 9 pull requests Successful merges: - rust-lang#86136 (Stabilize span_open() and span_close().) - rust-lang#86359 (Use as_secs_f64 in JunitFormatter) - rust-lang#86370 (Fix rustdoc stabilized versions layout) - rust-lang#86397 (Alter std::cell::Cell::get_mut documentation) - rust-lang#86407 (Use `map_or` instead of open-coding it) - rust-lang#86425 (Update rustversion to 1.0.5) - rust-lang#86440 (Update library tracking issue for libs-api rename.) - rust-lang#86444 (Fix ICE with `#[repr(simd)]` on enum) - rust-lang#86453 (stdlib: Fix typo in internal RefCell docs ) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
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.
I felt that there was some inconsistency between between Cell and RefCell with regards to their
get_mutmethod documentation:RefCellflags this method as "unusual" in that it takes&mut self, whileCelldoes not. I attempted to flag this inCells documentation as well, and point toRefCells method in the case where it is required.Find relevant parts of docs and the new version below.
The current docs for
Cell::get_mut:And
RefCell::get_mut:My attempt to make
Cell::get_mutclearer: