diff options
| author | Miguel Ojeda <ojeda@kernel.org> | 2023-12-29 22:26:23 +0100 |
|---|---|---|
| committer | Miguel Ojeda <ojeda@kernel.org> | 2023-12-29 22:26:23 +0100 |
| commit | dd928c8f75712bb25f140a3562463a613181e8c6 (patch) | |
| tree | 2ecafcd759acab6b1cfa6121ca2e16219bba953e | |
| parent | fb5ed726f72c6d16c788517c60ec00d4564b9348 (diff) | |
| download | rust-dd928c8f75712bb25f140a3562463a613181e8c6.tar.gz rust-dd928c8f75712bb25f140a3562463a613181e8c6.zip | |
Primitive docs: fix confusing `Send` in `&T`'s list
The two lists in this document describe what traits are implemented on
references when their underlying `T` also implements them. However,
while it is true that `T: Send + Sync` implies `&T: Send` (which is
what the sentence is trying to explain), it is confusing to have `Send`
in the list because `T: Send` is not needed for that. In particular,
the "also require" part may be interpreted as "both `T: Send` and
`T: Sync` are required".
Instead, move `Send` back to where it was before commit 7a477869b72e
("Makes docs for references a little less confusing"), i.e. to the `&mut`
list (where no extra nota is needed, i.e. it fits naturally) and move the
`Sync` definition/note to the bottom as something independent.
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
| -rw-r--r-- | library/core/src/primitive_docs.rs | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/library/core/src/primitive_docs.rs b/library/core/src/primitive_docs.rs index 99208fba670..bd2851a26fb 100644 --- a/library/core/src/primitive_docs.rs +++ b/library/core/src/primitive_docs.rs @@ -1348,7 +1348,6 @@ mod prim_usize {} /// * [`Fn`] \(in addition, `&T` references get [`FnMut`] and [`FnOnce`] if `T: Fn`) /// * [`Hash`] /// * [`ToSocketAddrs`] -/// * [`Send`] \(`&T` references also require <code>T: [Sync]</code>) /// * [`Sync`] /// /// [`std::fmt`]: fmt @@ -1366,6 +1365,7 @@ mod prim_usize {} /// * [`ExactSizeIterator`] /// * [`FusedIterator`] /// * [`TrustedLen`] +/// * [`Send`] /// * [`io::Write`] /// * [`Read`] /// * [`Seek`] @@ -1378,6 +1378,8 @@ mod prim_usize {} /// [`Read`]: ../std/io/trait.Read.html /// [`io::Write`]: ../std/io/trait.Write.html /// +/// In addition, `&T` references implement [`Send`] if and only if `T` implements [`Sync`]. +/// /// Note that due to method call deref coercion, simply calling a trait method will act like they /// work on references as well as they do on owned values! The implementations described here are /// meant for generic contexts, where the final type `T` is a type parameter or otherwise not |