hare

commit 6f88e34bdcc1db8c1b92b575f10a2069542aa6f3
parent bf9c87dc42e0366c4c118df8053fda83c72d1f21
Author: Drew DeVault <sir@cmpwn.com>
Date:   Mon, 28 Jun 2021 21:24:59 -0400

fs::fs: improve docs

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

Diffstat:
M
fs/types.ha
 | 
10
+++++++---

1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/fs/types.ha b/fs/types.ha
@@ -190,9 +190,13 @@ export type createfunc = fn(
 	flags: flags...
 ) (*io::stream | error);
 
-// An abstract implementation of a filesystem. To create a custom stream, embed
-// this type as the first member of a struct with user-specific data and fill
-// out these fields as appropriate.
+// An abstract implementation of a filesystem, which provides common filesystem
+// operations such as file creation and deletion, but which may be backed by any
+// underlying storage system. See [[os::cwd]] for access to the host filesystem.
+//
+// To create a custom filesystem implementation, embed this type as the first
+// member of a struct with user-specific data and fill out these fields as
+// appropriate.
 export type fs = struct {
 	// Frees resources associated with this filesystem.
 	close: nullable *closefunc,