From 94d228018746e1f29906dd9799c196d38156229a Mon Sep 17 00:00:00 2001
From: Pat Hickey <pat@moreproductive.org>
Date: Tue, 5 Jan 2021 11:01:52 -0800
Subject: [PATCH] better docs

---
 crates/wasi-c2/src/dir.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/crates/wasi-c2/src/dir.rs b/crates/wasi-c2/src/dir.rs
index e85bd85e28..718f499db9 100644
--- a/crates/wasi-c2/src/dir.rs
+++ b/crates/wasi-c2/src/dir.rs
@@ -267,7 +267,8 @@ impl WasiDir for cap_std::fs::Dir {
         // cap_std's read_dir does not include . and .., we should prepend these.
         // Why closures? failure of any individual entry doesn't mean the whole method should
         // fail.
-        // Why the tuple? We can't construct a cap_std::fs::DirEntry.
+        // Why is the Ok case a tuple? We can't construct a cap_std::fs::DirEntry, and we don't
+        // have enough info to make a ReaddirEntity yet.
         let rd = vec![
             (|| {
                 let meta = self.dir_metadata()?;