Minor text improvements #428
Conversation
| It internally manages exactly one copy of the data. Invoking `.clone()` on `Rc` | ||
| produces a new `Rc` instance, which points to the same data as the source `Rc`, | ||
| while increasing a reference count. The same applies to `Arc`, the thread-safe | ||
| counterpart of `Rc`. |
There was a problem hiding this comment.
It sounded like the use of heap is specific to Arc. I believe the use of heap is irrelevant here. I combined the best parts of Rc and Arc paragraphs and mentioned Arc at the end.
| [2](https://rust-lang.github.io/rust-clippy/master/index.html#clone_on_copy), | ||
| [3](https://rust-lang.github.io/rust-clippy/master/index.html#map_clone) or | ||
| [4](https://rust-lang.github.io/rust-clippy/master/index.html#clone_double_ref). | ||
| some cases in which `.clone()` is not necessary. |
There was a problem hiding this comment.
The last link is broken. I can see old mentions of clone_double_ref, perhaps it was removed. More importantly, clippy is unlikely to recommend removing .clone() if the compiler requires it (which is the premise of this page). But clippy can find something else that could be improved, which would in turn make .clone() unnecessary (e.g. clippy might suggest passing arguments to a function by reference so the value is not consumed). No need to focus on clone-specific lints.
| @@ -106,6 +106,6 @@ certain that there will be more deprecated APIs in the future. | |||
| `rustc --help` for a general list of options | |||
| - [rust-clippy] is a collection of lints for better Rust code | |||
|
|
|||
| [rust-clippy]: https://github.com/Manishearth/rust-clippy | |||
| [rust-clippy]: https://github.com/rust-lang/rust-clippy | |||
There was a problem hiding this comment.
The link was to a fork of the official rust-clippy repository. I don't see anything interesting in that fork. Let's link to the original.
| @@ -238,7 +238,7 @@ improve in the future. | |||
| This pattern is used throughout the standard library: | |||
|
|
|||
| - `Vec<u8>` can be cast from a String, unlike every other type of `Vec<T>`.[^1] | |||
| - They can also be cast into a binary heap, but only if they contain a type that | |||
| - Iterators can be cast into a binary heap, but only if they contain a type that | |||
There was a problem hiding this comment.
I don't know who "they" are. Looking at the link, it's iterators.
| @@ -275,7 +275,7 @@ struct TestStruct { | |||
| generate_visitor!(TestStruct); | |||
| ``` | |||
|
|
|||
| Or do they? | |||
| But let's actually try that approach. | |||
src/patterns/ffi/wrappers.md
Outdated
| @@ -153,7 +153,7 @@ optimizations that C code cannot attain. Being denied access to certain | |||
| shortcuts is the price Rust programmers need to pay. | |||
|
|
|||
| [^1]: For the C programmers out there scratching their heads, the iterator need | |||
| not be read *during* this code cause the UB. The exclusivity rule also enables | |||
| not be read *during* this code to cause the UB. The exclusivity rule also enables | |||
There was a problem hiding this comment.
I hope I understood that correctly. It might be better to move this text from the footnote and expand it for clarity.
Trying to clarify some parts of the book, whatever sounded unclear to me.