diff options
| author | Steve Klabnik <steve@steveklabnik.com> | 2015-07-17 18:50:42 -0400 |
|---|---|---|
| committer | Steve Klabnik <steve@steveklabnik.com> | 2015-07-17 18:50:42 -0400 |
| commit | 72dbbeef50d24efa424ff7ee2dd2f09ce2cd61cf (patch) | |
| tree | 2e77af588df99fbaad9a0e6cb955ae8e2a0d1c6a /src | |
| parent | b5dad7dcb22ed6bf8ebaae56b4339bd64f6983eb (diff) | |
| download | rust-72dbbeef50d24efa424ff7ee2dd2f09ce2cd61cf.tar.gz rust-72dbbeef50d24efa424ff7ee2dd2f09ce2cd61cf.zip | |
Remove confusing 'mutability root' term
And some other outdated language. @echochamber came asking about these docs on IRC today, and they're a bit weird. I've updated them to be less ambiguous and use contemporary terminology.
Diffstat (limited to 'src')
| -rw-r--r-- | src/libcore/cell.rs | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/libcore/cell.rs b/src/libcore/cell.rs index 37f37654c1f..2c4ebeafc0b 100644 --- a/src/libcore/cell.rs +++ b/src/libcore/cell.rs @@ -36,16 +36,16 @@ //! would otherwise be disallowed though, there are occasions when interior mutability might be //! appropriate, or even *must* be used, e.g. //! -//! * Introducing inherited mutability roots to shared types. +//! * Introducing mutability 'inside' of something immutable //! * Implementation details of logically-immutable methods. //! * Mutating implementations of `Clone`. //! -//! ## Introducing inherited mutability roots to shared types +//! ## Introducing mutability 'inside' of something immutable //! -//! Shared smart pointer types, including `Rc<T>` and `Arc<T>`, provide containers that can be +//! Many shared smart pointer types, including `Rc<T>` and `Arc<T>`, provide containers that can be //! cloned and shared between multiple parties. Because the contained values may be -//! multiply-aliased, they can only be borrowed as shared references, not mutable references. -//! Without cells it would be impossible to mutate data inside of shared boxes at all! +//! multiply-aliased, they can only be borrowed with `&`, not `&mut`. Without cells it would be +//! impossible to mutate data inside of these smart pointers at all. //! //! It's very common then to put a `RefCell<T>` inside shared pointer types to reintroduce //! mutability: @@ -65,8 +65,8 @@ //! ``` //! //! Note that this example uses `Rc<T>` and not `Arc<T>`. `RefCell<T>`s are for single-threaded -//! scenarios. Consider using `Mutex<T>` if you need shared mutability in a multi-threaded -//! situation. +//! scenarios. Consider using `RwLock<T>` or `Mutex<T>` if you need shared mutability in a +//! multi-threaded situation. //! //! ## Implementation details of logically-immutable methods //! |
