Mention that fs::canonicalize makes paths absolute.

diff --git a/src/libstd/fs.rs b/src/libstd/fs.rs
index 7bd1adc411ae4b1c0f19009c51f0faf1ff046643..f877c77ad7ff06b05ad5ea6f9a073bd97ae6fed2 100644 (file)
--- 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 696711a70d4f6408cc773abf87d04ed932e64b02..b670ae597b280e14c04b48ba9bcc406fde8f84b5 100644 (file)
--- a/src/libstd/path.rs
+++ b/src/libstd/path.rs
@@ -2284,8 +2284,8 @@ pub fn symlink_metadata(&self) -> io::Result<fs::Metadata> {
         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`].
     ///