1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-03-03 14:32:22 +02:00

ignore: clarify docs for DirEntry::error

Fixes #953
This commit is contained in:
Andrew Gallant 2018-08-21 19:59:33 -04:00
parent 0eef05142a
commit 95a4f15916

View File

@ -84,7 +84,8 @@ impl DirEntry {
/// Returns an error, if one exists, associated with processing this entry.
///
/// An example of an error is one that occurred while parsing an ignore
/// file.
/// file. Errors related to traversing a directory tree itself are reported
/// as part of yielding the directory entry, and not with this method.
pub fn error(&self) -> Option<&Error> {
self.err.as_ref()
}