summaryrefslogtreecommitdiffstats
path: root/ignore/src/walk.rs
diff options
context:
space:
mode:
Diffstat (limited to 'ignore/src/walk.rs')
-rw-r--r--ignore/src/walk.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/ignore/src/walk.rs b/ignore/src/walk.rs
index 09bac172..35b00066 100644
--- a/ignore/src/walk.rs
+++ b/ignore/src/walk.rs
@@ -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()
}