DirEntry::file_name: improve explanation

rust-lang · Jun 23, 2023 · 6f61f6b · 6f61f6b
1 parent 04075b3
commit 6f61f6b
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/library/std/src/fs.rs b/library/std/src/fs.rs
@@ -1755,8 +1755,14 @@ impl DirEntry {
         self.0.file_type().map(FileType)
     }
 
-    /// Returns the bare file name of this directory entry without any other
-    /// leading path component.
+    /// Returns the file name of this directory entry without any
+    /// leading path component(s).
+    ///
+    /// As an example,
+    /// the output of the function will result in "foo" for all the following paths:
+    /// - "./foo"
+    /// - "/the/foo"
+    /// - "../../foo"
     ///
     /// # Examples
     ///