about summary refs log tree commit diff
path: root/src/libcore/marker.rs
diff options
context:
space:
mode:
authorSteve Klabnik <steve@steveklabnik.com>2015-08-04 16:43:45 -0400
committerSteve Klabnik <steve@steveklabnik.com>2015-08-05 13:29:26 -0400
commit340c25aebfee25534b8b95fa7ed7afd35e0b2e4b (patch)
tree3333a6ab3c2cbb53f0bb0fd86dfdc6cd86b0001e /src/libcore/marker.rs
parentc980aba9a88704717229da3c1ec02685333c0db2 (diff)
downloadrust-340c25aebfee25534b8b95fa7ed7afd35e0b2e4b.tar.gz
rust-340c25aebfee25534b8b95fa7ed7afd35e0b2e4b.zip
Clarify claims about PhantomData<T>.
This wording was too strong.

Fixes #27523
Diffstat (limited to 'src/libcore/marker.rs')
-rw-r--r--src/libcore/marker.rs6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/libcore/marker.rs b/src/libcore/marker.rs
index ebd6ba544e4..c0956753c98 100644
--- a/src/libcore/marker.rs
+++ b/src/libcore/marker.rs
@@ -273,7 +273,11 @@ macro_rules! impls{
 /// even though it does not. This allows you to inform the compiler about certain safety properties
 /// of your code.
 ///
-/// Though they both have scary names, `PhantomData<T>` and "phantom types" are unrelated. 👻👻👻
+/// # A ghastly note 👻👻👻
+///
+/// Though they both have scary names, `PhantomData<T>` and 'phantom types' are related, but not
+/// identical. Phantom types are a more general concept that don't require `PhantomData<T>` to
+/// implement, but `PhantomData<T>` is the most common way to implement them in a correct manner.
 ///
 /// # Examples
 ///