about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorHuon Wilson <dbau.pp+github@gmail.com>2013-12-17 00:06:13 +1100
committerHuon Wilson <dbau.pp+github@gmail.com>2013-12-17 08:36:04 +1100
commit5c147cc40847da033674663cedabaf515eda8b20 (patch)
tree3436204da73dc3868a1afb151aaf8a1b9ad2f6dd /src/libstd
parentd0ae820765dbdbb941ee7f3a08aec895616b4db5 (diff)
downloadrust-5c147cc40847da033674663cedabaf515eda8b20.tar.gz
rust-5c147cc40847da033674663cedabaf515eda8b20.zip
std::vec::bytes: remove the reference to overlapping src and dest in
docs for copy_memory.

&mut [u8] and &[u8] really shouldn't be overlapping at all (part of the
uniqueness/aliasing guarantee of &mut), so no point in encouraging it.
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/vec.rs11
1 files changed, 4 insertions, 7 deletions
diff --git a/src/libstd/vec.rs b/src/libstd/vec.rs
index ed58185e3b0..a0c94e6810a 100644
--- a/src/libstd/vec.rs
+++ b/src/libstd/vec.rs
@@ -2350,13 +2350,10 @@ pub mod bytes {
         }
     }
 
-    /**
-      * Copies data from one vector to another.
-      *
-      * Copies `src` to `dst`. The source and destination may
-      * overlap. Fails if the length of `dst` is less than the length
-      * of `src`.
-      */
+    /// Copies data from one vector to another.
+    ///
+    /// Copies `src` to `dst`. Fails if the length of `dst` is less
+    /// than the length of `src`.
     #[inline]
     pub fn copy_memory(dst: &mut [u8], src: &[u8]) {
         // Bound checks are done at .copy_memory.