Slight copy-editing for std::cell::Cell docs
#55377
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
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
joshtriplett
requested changes
Oct 26, 2018
| /// // my_struct.regular_field = new_value; | ||
| /// | ||
| /// // WORKS, although `my_struct` is immutable, field `special_field` is mutable because it is Cell |
There was a problem hiding this comment.
Here, the old version is clearer because it explicitly says "is mutable because". (Cleaning up the grammar would be helpful, though.)
src/libcore/cell.rs
Outdated
| @@ -225,10 +225,10 @@ use ptr; | |||
| /// | |||
| /// let new_value = 100; | |||
| /// | |||
| /// // ERROR, because my_struct is immutable | |||
| /// // ERROR: my_struct is immutable | |||
There was a problem hiding this comment.
I don't think this is clearer.
src/libcore/cell.rs
Outdated
| /// Here you can see how using `Cell<T>` allows to use mutable field inside | ||
| /// immutable struct (which is also called 'interior mutability'). | ||
| /// In this example, you can see that `Cell<T>` enables mutation inside an | ||
| /// immutable struct. In other words, it enables interior mutability. |
There was a problem hiding this comment.
This seems like an improvement, except that you should still keep the explicit quoting on 'interior mutability' to make it clear that it defines this new term.
Hopefully this is a bit more precise and also more correct English.
|
Ping from triage @joshtriplett: It looks like this PR is ready for your review again. |
|
@bors r+ rollup |
|
📌 Commit 6df57a7 has been approved by |
bors
added
S-waiting-on-bors
kennytm
added a commit
to kennytm/rust
that referenced
this pull request
Nov 7, 2018
Slight copy-editing for `std::cell::Cell` docs Hopefully this is a bit more precise and also more correct English.
bors
added a commit
that referenced
this pull request
Nov 7, 2018
Rollup of 14 pull requests Successful merges: - #55377 (Slight copy-editing for `std::cell::Cell` docs) - #55441 (Remove unused re import in gdb_rust_pretty_printing) - #55453 (Choose predicates without inference variables over those with them) - #55495 (Don't print opt fuel messages to stdout because it breaks Rustbuild) - #55501 (Make `process_obligations`' computation of `completed` optional.) - #55510 (Fix feature gate only being checked on first repr attr.) - #55609 (Run name-anon-globals after LTO passes as well) - #55645 (do not print wrapping ranges like normal ranges in validity diagnostics) - #55688 (Standardised names and location of ui issue tests) - #55692 (-C remark: fix incorrect warning about requiring "--debuginfo" instead of "-C debuginfo=n") - #55702 (Add `aarch64-pc-windows-msvc` to deployed targets) - #55728 (Update lldb) - #55730 (Use trait impl method span when type param mismatch is due to impl Trait) - #55734 (refactor: use shorthand fields)
alexreg
pushed a commit
to alexreg/rust
that referenced
this pull request
Nov 7, 2018
Rollup of 14 pull requests Successful merges: - rust-lang#55377 (Slight copy-editing for `std::cell::Cell` docs) - rust-lang#55441 (Remove unused re import in gdb_rust_pretty_printing) - rust-lang#55453 (Choose predicates without inference variables over those with them) - rust-lang#55495 (Don't print opt fuel messages to stdout because it breaks Rustbuild) - rust-lang#55501 (Make `process_obligations`' computation of `completed` optional.) - rust-lang#55510 (Fix feature gate only being checked on first repr attr.) - rust-lang#55609 (Run name-anon-globals after LTO passes as well) - rust-lang#55645 (do not print wrapping ranges like normal ranges in validity diagnostics) - rust-lang#55688 (Standardised names and location of ui issue tests) - rust-lang#55692 (-C remark: fix incorrect warning about requiring "--debuginfo" instead of "-C debuginfo=n") - rust-lang#55702 (Add `aarch64-pc-windows-msvc` to deployed targets) - rust-lang#55728 (Update lldb) - rust-lang#55730 (Use trait impl method span when type param mismatch is due to impl Trait) - rust-lang#55734 (refactor: use shorthand fields)
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.
Hopefully this is a bit more precise and also more correct English.