about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorNick Cameron <ncameron@mozilla.com>2015-05-13 15:09:17 +1200
committerNick Cameron <ncameron@mozilla.com>2015-05-13 15:09:17 +1200
commit103e52b1db92b9ac57dcebf5c5738ad5a45155ad (patch)
treef25dde7fb14152c900f89c7b9c85e63b1439c828 /src/libstd
parent5d16772ecb93270ac64b44b429a157f397a3e41d (diff)
parentc2b30b86df6b34ba19e87e63402e43d9e81a64fb (diff)
downloadrust-103e52b1db92b9ac57dcebf5c5738ad5a45155ad.tar.gz
rust-103e52b1db92b9ac57dcebf5c5738ad5a45155ad.zip
Merge branch 'master' into mulit-decor
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/collections/hash/map.rs18
-rw-r--r--src/libstd/io/mod.rs4
-rw-r--r--src/libstd/path.rs8
-rw-r--r--src/libstd/thread/local.rs2
-rw-r--r--src/libstd/thread/scoped_tls.rs2
5 files changed, 31 insertions, 3 deletions
diff --git a/src/libstd/collections/hash/map.rs b/src/libstd/collections/hash/map.rs
index 9b824f11b92..48f65a5abfd 100644
--- a/src/libstd/collections/hash/map.rs
+++ b/src/libstd/collections/hash/map.rs
@@ -916,6 +916,24 @@ impl<K, V, S> HashMap<K, V, S>
     }
 
     /// Gets the given key's corresponding entry in the map for in-place manipulation.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::collections::HashMap;
+    ///
+    /// let mut letters = HashMap::new();
+    ///
+    /// for ch in "a short treatise on fungi".chars() {
+    ///     let counter = letters.entry(ch).or_insert(0);
+    ///     *counter += 1;
+    /// }
+    ///
+    /// assert_eq!(letters[&'s'], 2);
+    /// assert_eq!(letters[&'t'], 3);
+    /// assert_eq!(letters[&'u'], 1);
+    /// assert_eq!(letters.get(&'y'), None);
+    /// ```
     #[stable(feature = "rust1", since = "1.0.0")]
     pub fn entry(&mut self, key: K) -> Entry<K, V> {
         // Gotta resize now.
diff --git a/src/libstd/io/mod.rs b/src/libstd/io/mod.rs
index 9089b417fcb..e7b2b01d09f 100644
--- a/src/libstd/io/mod.rs
+++ b/src/libstd/io/mod.rs
@@ -844,7 +844,7 @@ impl fmt::Display for CharsError {
 /// An iterator over the contents of an instance of `BufRead` split on a
 /// particular byte.
 ///
-/// See `BufReadExt::split` for more information.
+/// See `BufRead::split` for more information.
 #[stable(feature = "rust1", since = "1.0.0")]
 pub struct Split<B> {
     buf: B,
@@ -873,7 +873,7 @@ impl<B: BufRead> Iterator for Split<B> {
 /// An iterator over the lines of an instance of `BufRead` split on a newline
 /// byte.
 ///
-/// See `BufReadExt::lines` for more information.
+/// See `BufRead::lines` for more information.
 #[stable(feature = "rust1", since = "1.0.0")]
 pub struct Lines<B> {
     buf: B,
diff --git a/src/libstd/path.rs b/src/libstd/path.rs
index 8ccc387c902..934b3156357 100644
--- a/src/libstd/path.rs
+++ b/src/libstd/path.rs
@@ -1199,7 +1199,7 @@ impl Into<OsString> for PathBuf {
 /// absolute, and so on. More details about the overall approach can be found in
 /// the module documentation.
 ///
-/// This is an *unsized* type, meaning that it must always be used with behind a
+/// This is an *unsized* type, meaning that it must always be used behind a
 /// pointer like `&` or `Box`.
 ///
 /// # Examples
@@ -1449,6 +1449,8 @@ impl Path {
 
     /// Determines whether `base` is a prefix of `self`.
     ///
+    /// Only considers whole path components to match.
+    ///
     /// # Examples
     ///
     /// ```
@@ -1457,6 +1459,8 @@ impl Path {
     /// let path = Path::new("/etc/passwd");
     ///
     /// assert!(path.starts_with("/etc"));
+    ///
+    /// assert!(!path.starts_with("/e"));
     /// ```
     #[stable(feature = "rust1", since = "1.0.0")]
     pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool {
@@ -1465,6 +1469,8 @@ impl Path {
 
     /// Determines whether `child` is a suffix of `self`.
     ///
+    /// Only considers whole path components to match.
+    ///
     /// # Examples
     ///
     /// ```
diff --git a/src/libstd/thread/local.rs b/src/libstd/thread/local.rs
index 41bdf034705..2e043c58a5d 100644
--- a/src/libstd/thread/local.rs
+++ b/src/libstd/thread/local.rs
@@ -85,6 +85,8 @@ pub struct LocalKey<T> {
 }
 
 /// Declare a new thread local storage key of type `std::thread::LocalKey`.
+///
+/// See [LocalKey documentation](thread/struct.LocalKey.html) for more information.
 #[macro_export]
 #[stable(feature = "rust1", since = "1.0.0")]
 #[allow_internal_unstable]
diff --git a/src/libstd/thread/scoped_tls.rs b/src/libstd/thread/scoped_tls.rs
index 35684a1f390..e195c3aaa3f 100644
--- a/src/libstd/thread/scoped_tls.rs
+++ b/src/libstd/thread/scoped_tls.rs
@@ -66,6 +66,8 @@ pub struct ScopedKey<T> { #[doc(hidden)] pub inner: __impl::KeyInner<T> }
 ///
 /// This macro declares a `static` item on which methods are used to get and
 /// set the value stored within.
+///
+/// See [ScopedKey documentation](thread/struct.ScopedKey.html) for more information.
 #[macro_export]
 #[allow_internal_unstable]
 macro_rules! scoped_thread_local {