user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix formatting and links in previous doc change.

Browse source
This commit is contained in:
Jack Vickeridge 2017-01-19 22:00:57 +00:00
parent ea70a88710
commit e8f2e2b521
1 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

14
src/libstd/fs.rs
View file

@ -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
///