chore: Improve doc comments

jieyouxu · Nov 26, 2024 · f4ab982 · f4ab982
1 parent 692c19a
commit f4ab982
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/library/std/src/sys/pal/wasi/fs.rs b/library/std/src/sys/pal/wasi/fs.rs
@@ -31,7 +31,7 @@ pub struct ReadDir {
 }
 
 enum ReadDirState {
-    /// Next DirEntry should be read from contents of buf at `offset`
+    /// Fill `buf` with `buf.len()` bytes starting from `next_read_offset`.
     FillBuffer {
         next_read_offset: wasi::Dircookie,
         buf: Vec<u8>,
@@ -41,7 +41,8 @@ enum ReadDirState {
         next_read_offset: Option<wasi::Dircookie>,
         offset: usize,
     },
-    /// Do not fetch any more entries, process all entries
+    /// There is no more data to get in [`Self::FillBuffer`]; keep returning
+    /// entries via ProcessEntry until `buf` is exhausted.
     RunUntilExhaustion {
         buf: Vec<u8>,
         offset: usize,