Skip to content

Use fs::symlink_metadata in doc for is_symlink #39176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 22, 2017
Merged

Use fs::symlink_metadata in doc for is_symlink #39176

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ea70a88
Use fs::symlink_metadata in doc for is_symlink
CartesianDaemon Jan 19, 2017
e8f2e2b
Fix formatting and links in previous doc change.
CartesianDaemon Jan 19, 2017
fe9f5d5
Add link to symlink_metadata in fs::Metadata doc
CartesianDaemon Jan 19, 2017
f55bbaa
Revert "Add link to symlink_metadata in fs::Metadata doc"
CartesianDaemon Jan 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/libstd/fs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -975,13 +975,18 @@ impl FileType {

/// Test whether this file type represents a symbolic link.
///
/// The Metadata struct needs to be retreived with
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This place wants more inline-code annotations, so it looks like

retrieved with fs::symlink_metadata() not fs::metadata().

and not

retrieved with fs::symlink_metadata() not fs::metadata().

You can achieve that enclosing the inline code snippets within the grave (`) symbols. Like this:

retrieved with `fs::symlink_metadata()` not `fs::metadata()`.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"retreived" -> "retrieved" maybe?

/// fs::symlink_metadata() not fs::metadata(). metadata()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing urls.

/// always follows symbolic links, so is_symlink will
/// always return false for the underlying file.
///
/// # Examples
///
/// ```
/// # fn foo() -> std::io::Result<()> {
/// use std::fs;
///
/// let metadata = try!(fs::metadata("foo.txt"));
/// let metadata = try!(fs::symlink_metadata("foo.txt"));
/// let file_type = metadata.file_type();
///
/// assert_eq!(file_type.is_symlink(), false);
Expand Down