about summary refs log tree commit diff
path: root/src/libcore
diff options
context:
space:
mode:
authorDylan DPC <dylan.dpc@gmail.com>2020-06-01 03:14:16 +0200
committerGitHub <noreply@github.com>2020-06-01 03:14:16 +0200
commit16b4dc0489fca20d328c8f6effb8d7a9d1ef944d (patch)
treee0134fe42a0e4660f6fb363a5af4e8c482a499be /src/libcore
parentb6a5fea2ceee9a664e0dd808f1b5d3365311d0cc (diff)
parent3048a41a5a042c2633a4d87ea38e04a1407f5bd3 (diff)
downloadrust-16b4dc0489fca20d328c8f6effb8d7a9d1ef944d.tar.gz
rust-16b4dc0489fca20d328c8f6effb8d7a9d1ef944d.zip
Rollup merge of #72834 - JOE1994:correct_confusing_term, r=sfackler
Rephrase term 'non-pointer type'

Hello :cat2: ,

If the reader assumes that 'pointer type's include 'smart pointer's,
the term 'non-pointer type' could mislead the reader to assume that
x should not be a smart pointer type. I tried to rephrase the term
'non-pointer type' to remove ambiguity in the doc comments.

closes #72335

Thank you for reviewing this PR! :superhero_woman:
Diffstat (limited to 'src/libcore')
-rw-r--r--src/libcore/ops/deref.rs8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/libcore/ops/deref.rs b/src/libcore/ops/deref.rs
index 6e96aa330ff..3faeb170b06 100644
--- a/src/libcore/ops/deref.rs
+++ b/src/libcore/ops/deref.rs
@@ -18,8 +18,8 @@
 ///
 /// If `T` implements `Deref<Target = U>`, and `x` is a value of type `T`, then:
 ///
-/// * In immutable contexts, `*x` on non-pointer types is equivalent to
-///   `*Deref::deref(&x)`.
+/// * In immutable contexts, `*x` (where `T` is neither a reference nor a raw pointer)
+///   is equivalent to `*Deref::deref(&x)`.
 /// * Values of type `&T` are coerced to values of type `&U`
 /// * `T` implicitly implements all the (immutable) methods of the type `U`.
 ///
@@ -115,8 +115,8 @@ impl<T: ?Sized> Deref for &mut T {
 /// If `T` implements `DerefMut<Target = U>`, and `x` is a value of type `T`,
 /// then:
 ///
-/// * In mutable contexts, `*x` on non-pointer types is equivalent to
-///   `*DerefMut::deref_mut(&mut x)`.
+/// * In mutable contexts, `*x` (where `T` is neither a reference nor a raw pointer)
+///   is equivalent to `*DerefMut::deref_mut(&mut x)`.
 /// * Values of type `&mut T` are coerced to values of type `&mut U`
 /// * `T` implicitly implements all the (mutable) methods of the type `U`.
 ///