Update library/std/src/path.rs

Co-authored-by: Jane Lusby <jlusby42@gmail.com>
rust-lang · Oct 12, 2021 · 36e050b · 36e050b
1 parent 55663a7
commit 36e050b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/library/std/src/path.rs b/library/std/src/path.rs
@@ -2743,6 +2743,12 @@ impl Path {
     /// assert_eq!(link_path.is_symlink(), true);
     /// assert_eq!(link_path.exists(), false);
     /// ```
+    ///
+    /// # See Also
+    ///
+    /// This is a convenience function that coerces errors to false. If you want to
+    /// check errors, call [`fs::symlink_metadata`] and handle its [`Result`]. Then call
+    /// [`fs::Metadata::is_symlink`] if it was [`Ok`].
     #[stable(feature = "is_symlink", since = "1.57.0")]
     pub fn is_symlink(&self) -> bool {
         fs::symlink_metadata(self).map(|m| m.is_symlink()).unwrap_or(false)