From 95a4f15916699a1188f7b27c7eb71f850f404098 Mon Sep 17 00:00:00 2001
From: Andrew Gallant <jamslam@gmail.com>
Date: Tue, 21 Aug 2018 19:59:33 -0400
Subject: ignore: clarify docs for DirEntry::error

Fixes #953
---
 ignore/src/walk.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

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()
     }
-- 
cgit v1.2.3