DirEntry::file_name: improve explanation

This commit is contained in:
Tshepang Mbambo 2023-06-23 04:47:30 +02:00 committed by GitHub
parent 04075b3202
commit 6f61f6ba11
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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
///