Rollup merge of #56858 - tbu-:pr_doc_canonicalize, r=shepmaster

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.
This commit is contained in:
Mazdak Farrokhzad 2018-12-16 14:08:40 +01:00 committed by GitHub
commit 6574d83dcf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

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