about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorManish Goregaokar <manishsmail@gmail.com>2015-05-11 19:58:57 +0530
committerManish Goregaokar <manishsmail@gmail.com>2015-05-11 19:58:57 +0530
commitf2c2736cd8ac05315bd32e82e7433a168631bb36 (patch)
tree46a9bd9db71858539475d1433e9003c2ddf98001 /src/libstd
parent8f01d8d7c290f24980e2915b2df14d244eb430a2 (diff)
parentaabdd8e0a607643915020c072923fdf135358921 (diff)
downloadrust-f2c2736cd8ac05315bd32e82e7433a168631bb36.tar.gz
rust-f2c2736cd8ac05315bd32e82e7433a168631bb36.zip
Rollup merge of #25290 - bluss:docfixes, r=steveklabnik
Several Minor API / Reference Documentation Fixes

- Fix a few small errors in the reference.
- Fix paper cuts in the API docs.

Fixes #24882
Fixes #25233
Fixes #25250
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/path.rs6
-rw-r--r--src/libstd/thread/local.rs2
-rw-r--r--src/libstd/thread/scoped_tls.rs2
3 files changed, 10 insertions, 0 deletions
diff --git a/src/libstd/path.rs b/src/libstd/path.rs
index 8ccc387c902..21f873e6877 100644
--- a/src/libstd/path.rs
+++ b/src/libstd/path.rs
@@ -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 {