Skip to content

Commit

Permalink
Rollup merge of #56858 - tbu-:pr_doc_canonicalize, r=shepmaster
Browse files Browse the repository at this point in the history
Fix doc of `std::fs::canonicalize`

Point out that the final component of the path name might be a filename
(and not a directory name). Previously, the doc said that all components
of the path must be directory names, when it actually only ment all but
the final one.

Fixes #54056.
  • Loading branch information
Centril committed Dec 16, 2018
2 parents cee0bdd + f61686a commit 6574d83
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/libstd/fs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1729,7 +1729,7 @@ pub fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
/// limited to just these cases:
///
/// * `path` does not exist.
/// * A component in path is not a directory.
/// * A non-final component in path is not a directory.
///
/// # Examples
///
Expand Down

0 comments on commit 6574d83

Please sign in to comment.