hare

commit 10d78afae2c706b3c9b3bca31d8b463e9738a3f2
parent 69150521f8d3e0d172c07edb265fe09914444f9e
Author: Drew DeVault <sir@cmpwn.com>
Date:   Wed,  6 Jul 2022 15:26:18 +0200

os::iter: improve documentation

Signed-off-by: Drew DeVault <sir@cmpwn.com>

Diffstat:
M
os/fs.ha
 | 
4
+++-

1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/os/fs.ha b/os/fs.ha
@@ -24,7 +24,9 @@ export fn rename(oldpath: str, newpath: str) (void | fs::error) =
 export fn move(oldpath: str, newpath: str) (void | fs::error) =
 	fs::move(cwd, oldpath, newpath);
 
-// Creates an [[fs::iterator]] for a given directory to read its contents.
+// Creates an [[fs::iterator]] for a given directory to read its contents. The
+// user should call [[fs::next]] to enumerate entries, and [[fs::finish]] when
+// done using the object.
 export fn iter(path: str) (*fs::iterator | fs::error) = fs::iter(cwd, path);
 
 // Frees state associated with a directory iterator.