about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorMazdak Farrokhzad <twingoow@gmail.com>2018-12-16 14:08:40 +0100
committerGitHub <noreply@github.com>2018-12-16 14:08:40 +0100
commit6574d83dcffda1569976f40c7e09c799d3e04241 (patch)
treef2b306d49b229095e92d312edcb1efe89b724829 /src/libstd
parentcee0bddd0a4e0eb3ea8d7025f25ea95cb6a5c5ef (diff)
parentf61686ae705a8d149a922b52cb09a9298d7b7cad (diff)
downloadrust-6574d83dcffda1569976f40c7e09c799d3e04241.tar.gz
rust-6574d83dcffda1569976f40c7e09c799d3e04241.zip
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.
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/fs.rs2
1 files changed, 1 insertions, 1 deletions
diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs
index edcfdd9e534..35ae4939249 100644
--- a/src/libstd/fs.rs
+++ b/src/libstd/fs.rs
@@ -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
 ///