about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
authorTim Allen <screwtape@froup.com>2018-05-10 18:05:29 +1000
committerTim Allen <screwtape@froup.com>2018-05-10 18:05:29 +1000
commit9d7eda96ee57ed951bd93a420814c6f8c65c1cf2 (patch)
tree20c6875bc86c88d41deba28c947699b6bf7e59df /src/libstd
parent8ff4b42064b374bb62043f7729f84b6d979c7667 (diff)
Mention that fs::canonicalize makes paths absolute.
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/fs.rs4
-rw-r--r--src/libstd/path.rs4
2 files changed, 4 insertions, 4 deletions
diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs
index 7bd1adc411a..f877c77ad7f 100644
--- a/src/libstd/fs.rs
+++ b/src/libstd/fs.rs
@@ -1699,8 +1699,8 @@ pub fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
     fs_imp::readlink(path.as_ref())
 }
 
-/// Returns the canonical form of a path with all intermediate components
-/// normalized and symbolic links resolved.
+/// Returns the canonical, absolute form of a path with all intermediate
+/// components normalized and symbolic links resolved.
 ///
 /// # Platform-specific behavior
 ///
diff --git a/src/libstd/path.rs b/src/libstd/path.rs
index 696711a70d4..b670ae597b2 100644
--- a/src/libstd/path.rs
+++ b/src/libstd/path.rs
@@ -2284,8 +2284,8 @@ impl Path {
         fs::symlink_metadata(self)
     }
 
-    /// Returns the canonical form of the path with all intermediate components
-    /// normalized and symbolic links resolved.
+    /// Returns the canonical, absolute form of the path with all intermediate
+    /// components normalized and symbolic links resolved.
     ///
     /// This is an alias to [`fs::canonicalize`].
     ///