about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAndrew Paseltiner <apaseltiner@gmail.com>2016-08-03 20:22:43 -0400
committerAndrew Paseltiner <apaseltiner@gmail.com>2016-08-05 17:52:37 -0400
commitda2b7a65b9d51948d0640474f6c7c0d729ef674e (patch)
tree901298e4845c902962ce419a8748afb06827e796
parent9316ae515e2f8f3f497fb4f1559910c1eef2433d (diff)
downloadrust-da2b7a65b9d51948d0640474f6c7c0d729ef674e.tar.gz
rust-da2b7a65b9d51948d0640474f6c7c0d729ef674e.zip
Clean up `std::raw` docs
There is no longer a `Repr` trait, so mentioning a missing impl of it
was potentially confusing.
-rw-r--r--src/libcore/raw.rs16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/libcore/raw.rs b/src/libcore/raw.rs
index 6b2122451db..a7d0d3899b1 100644
--- a/src/libcore/raw.rs
+++ b/src/libcore/raw.rs
@@ -34,12 +34,13 @@
 /// only designed to be used by unsafe code that needs to manipulate
 /// the low-level details.
 ///
-/// There is no `Repr` implementation for `TraitObject` because there
-/// is no way to refer to all trait objects generically, so the only
+/// There is no way to refer to all trait objects generically, so the only
 /// way to create values of this type is with functions like
-/// `std::mem::transmute`. Similarly, the only way to create a true
+/// [`std::mem::transmute`][transmute]. Similarly, the only way to create a true
 /// trait object from a `TraitObject` value is with `transmute`.
 ///
+/// [transmute]: ../intrinsics/fn.transmute.html
+///
 /// Synthesizing a trait object with mismatched types—one where the
 /// vtable does not correspond to the type of the value to which the
 /// data pointer points—is highly likely to lead to undefined
@@ -50,13 +51,13 @@
 /// ```
 /// #![feature(raw)]
 ///
-/// use std::mem;
-/// use std::raw;
+/// use std::{mem, raw};
 ///
 /// // an example trait
 /// trait Foo {
 ///     fn bar(&self) -> i32;
 /// }
+///
 /// impl Foo for i32 {
 ///     fn bar(&self) -> i32 {
 ///          *self + 1
@@ -74,7 +75,6 @@
 /// // the data pointer is the address of `value`
 /// assert_eq!(raw_object.data as *const i32, &value as *const _);
 ///
-///
 /// let other_value: i32 = 456;
 ///
 /// // construct a new object, pointing to a different `i32`, being
@@ -82,11 +82,11 @@
 /// let synthesized: &Foo = unsafe {
 ///      mem::transmute(raw::TraitObject {
 ///          data: &other_value as *const _ as *mut (),
-///          vtable: raw_object.vtable
+///          vtable: raw_object.vtable,
 ///      })
 /// };
 ///
-/// // it should work just like we constructed a trait object out of
+/// // it should work just as if we had constructed a trait object out of
 /// // `other_value` directly
 /// assert_eq!(synthesized.bar(), 457);
 /// ```