hare

commit 7fc1fcb3a3bbe664ab7efd70f30518cbfaeb4961
parent ddaf854a00840adc7e7e5c13f3fae9e4d0ea9a8c
Author: Bor Grošelj Simić <bgs@turminal.net>
Date:   Wed,  1 Jun 2022 14:50:25 +0200

fs: document correct iterator disposal method

Signed-off-by: Bor Grošelj Simić <bgs@turminal.net>

Diffstat:
M
fs/fs.ha
 | 
2
+-

1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/fs/fs.ha b/fs/fs.ha
@@ -139,7 +139,7 @@ export fn move(fs: *fs, oldpath: str, newpath: str) (void | error) = {
 
 // Returns an iterator for a path, which yields the contents of a directory.
 // Pass empty string to yield from the root. The order in which entries are
-// returned is undefined.
+// returned is undefined. The return value must be finished with [[fs::finish]].
 export fn iter(fs: *fs, path: str) (*iterator | error) = {
 	match (fs.iter) {
 	case null =>