Update cell.rs, correct module level doc #146863
Open
+2
−2
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
This change corrects the Cell<T> section by replacing `&mut` with `&` so the statement reads "an &T to the inner value can never be obtained". It also emphasizes that a single &mut T to the inner value can be obtained (e.g. via method core::cell::Cell::get_mut).
rustbot
added
S-waiting-on-review
tgross35
requested changes
Sep 21, 2025
| //! | ||
| //! [`Cell<T>`] implements interior mutability by moving values in and out of the cell. That is, an | ||
| //! `&mut T` to the inner value can never be obtained, and the value itself cannot be directly | ||
| //! `& T` to the inner value can never be obtained, and the value itself cannot be directly |
There was a problem hiding this comment.
Maybe more clear as "&T or &mut T".
Also, this should be &T rather than & T (no space).
| //! `& T` to the inner value can never be obtained, and the value itself cannot be directly | ||
| //! obtained without replacing it with something else. Both of these rules ensure that there is | ||
| //! never more than one reference pointing to the inner value. This type provides the following | ||
| //! never more than one mutable reference pointing to the inner value. This type provides the following |
There was a problem hiding this comment.
The original was correct here; we also can't have >1 shared reference (because .set(x) would replace the value they point to).
rustbot
added
S-waiting-on-author
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 change corrects the Cell section by replacing
&mutwith&so the statement reads "an &T to the inner value can never be obtained". It also emphasizes that a single &mut T to the inner value can be obtained (e.g. via method core::cell::Cell::get_mut).