hare

commit 80e901354972f70791d7e889d347c2ab7a164ded
parent aaffce1191b68fd8a731cad9c6065bf0b4336993
Author: Drew DeVault <sir@cmpwn.com>
Date:   Sun, 27 Jun 2021 10:43:42 -0400

temp: improve docs

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

Diffstat:
M
temp/+linux.ha
 | 
6
+++++-

1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/temp/+linux.ha b/temp/+linux.ha
@@ -33,12 +33,16 @@ export fn file(
 		oflags |= fs::flags::WRONLY;
 	};
 	return match (os::create(get_tmpdir(), fmode, oflags)) {
+		// TODO: Add a custom "close" function which removes the named
+		// file
 		err: fs::error => named(get_tmpdir(), iomode, mode...),
 		s: *io::stream => s,
 	};
 };
 
-// Creates a named temporary file in the given directory.
+// Creates a named temporary file in the given directory. The path to the
+// temporary file may be found via the name field of [[io::stream]]. The caller
+// is responsible for removing the file when they're done with it.
 //
 // The I/O mode must be either [[io::mode::WRITE]] or [[io::mode::RDWR]].
 //