Fix unclear make_mut description #31397
Merged
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
|
@bors: r+ rollup agreed, thanks! |
|
📌 Commit fa74a83 has been approved by |
| /// Make a mutable reference into the given `Arc<T>` by cloning the inner | ||
| /// data if the `Arc<T>` doesn't have one strong reference and no weak | ||
| /// references. | ||
| /// Make a mutable reference into the given `Arc<T>`. |
There was a problem hiding this comment.
make tidy flagged the trailing space here
Changed the description of the `make_mut` copy-on-write behaviour in arc.rs The sentence "doesn't have one strong reference and no weak references." is a hard to understand double negative, which can be much more easily explained.
|
@steveklabnik My mistake for screwing up the whitespace. Can you re-approve for bors? |
|
@bors: r+ rollup no worries, I do it all the time :) |
|
📌 Commit 3cafce6 has been approved by |
bors
added a commit
that referenced
this pull request
Feb 8, 2016
The documentation for the `make_mut` function on `Arc<T>` contains a somewhat impenetrable double-negative that I was only able to fully grasp by looking at the implementation. Here's a quick rewrite that reads a lot better. The sentence "doesn't have one strong reference and no weak references." is a hard to understand, and it can be much more easily explained. In particular, such a double-negative could give English as a Second Language users even more trouble than native speakers. r? @steveklabnik
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.
The documentation for the
make_mutfunction onArc<T>contains a somewhat impenetrable double-negative that I was only able to fully grasp by looking at the implementation. Here's a quick rewrite that reads a lot better.The sentence "doesn't have one strong reference and no weak references." is a
hard to understand, and it can be much more easily explained. In particular, such a double-negative
could give English as a Second Language users even more trouble than native speakers.
r? @steveklabnik