about summary refs log tree commit diff
path: root/src/libstd/fs.rs
diff options
context:
space:
mode:
authorJack Vickeridge <jackv@cantab.net>2017-01-19 22:00:57 +0000
committerJack Vickeridge <jackv@cantab.net>2017-01-20 00:38:46 +0000
commite8f2e2b52128b2cd420478616dd289beec20351e (patch)
treea5951d20957b3caa0d9aa879348299ecd66e971a /src/libstd/fs.rs
parentea70a88710f45c4403c2cb21f291f895ef33b627 (diff)
downloadrust-e8f2e2b52128b2cd420478616dd289beec20351e.tar.gz
rust-e8f2e2b52128b2cd420478616dd289beec20351e.zip
Fix formatting and links in previous doc change.
Diffstat (limited to 'src/libstd/fs.rs')
-rw-r--r--src/libstd/fs.rs14
1 files changed, 10 insertions, 4 deletions
diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs
index 898ca55f2fe..26fcd348fc9 100644
--- a/src/libstd/fs.rs
+++ b/src/libstd/fs.rs
@@ -975,10 +975,16 @@ impl FileType {
 
     /// Test whether this file type represents a symbolic link.
     ///
-    /// The Metadata struct needs to be retreived with
-    /// fs::symlink_metadata() not fs::metadata(). metadata()
-    /// always follows symbolic links, so is_symlink will
-    /// always return false for the underlying file.
+    /// The underlying [`Metadata`] struct needs to be retrieved
+    /// with the [`fs::symlink_metadata`] function and not the
+    /// [`fs::metadata`] function. The [`fs::metadata`] function
+    /// follows symbolic links, so [`is_symlink`] would always
+    /// return false for the target file.
+    ///
+    /// [`Metadata`]: struct.Metadata.html
+    /// [`fs::metadata`]: fn.metadata.html
+    /// [`fs::symlink_metadata`]: fn.symlink_metadata.html
+    /// [`is_symlink`]: struct.FileType.html#method.is_symlink
     ///
     /// # Examples
     ///