Skip to content

Commit e8f2e2b

Browse files
Fix formatting and links in previous doc change.
1 parent ea70a88 commit e8f2e2b

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

src/libstd/fs.rs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -975,10 +975,16 @@ impl FileType {
975975

976976
/// Test whether this file type represents a symbolic link.
977977
///
978-
/// The Metadata struct needs to be retreived with
979-
/// fs::symlink_metadata() not fs::metadata(). metadata()
980-
/// always follows symbolic links, so is_symlink will
981-
/// always return false for the underlying file.
978+
/// The underlying [`Metadata`] struct needs to be retrieved
979+
/// with the [`fs::symlink_metadata`] function and not the
980+
/// [`fs::metadata`] function. The [`fs::metadata`] function
981+
/// follows symbolic links, so [`is_symlink`] would always
982+
/// return false for the target file.
983+
///
984+
/// [`Metadata`]: struct.Metadata.html
985+
/// [`fs::metadata`]: fn.metadata.html
986+
/// [`fs::symlink_metadata`]: fn.symlink_metadata.html
987+
/// [`is_symlink`]: struct.FileType.html#method.is_symlink
982988
///
983989
/// # Examples
984990
///

0 commit comments

Comments
 (0)