aboutsummaryrefslogtreecommitdiff
path: root/format
diff options
context:
space:
mode:
authorJulian Hurst <ark@mansus.space>2024-11-15 01:14:07 +0100
committerJulian Hurst <ark@mansus.space>2024-11-15 01:14:07 +0100
commite93b97aa88cbec8b026994b715809ad14a106e1f (patch)
tree63235c66a51bc4a3f44eb122e22b381a48684e26 /format
parent184a4cbcc8249ba16b25d918779800e626beea9e (diff)
downloadhatask-e93b97aa88cbec8b026994b715809ad14a106e1f.tar.gz
tsv: Improve readrecords doc
Diffstat (limited to 'format')
-rw-r--r--format/tsv/reader.ha3
1 files changed, 2 insertions, 1 deletions
diff --git a/format/tsv/reader.ha b/format/tsv/reader.ha
index df2ba35..326e24b 100644
--- a/format/tsv/reader.ha
+++ b/format/tsv/reader.ha
@@ -5,7 +5,8 @@ use strings;
use memio;
use fmt;
-// Reads records from an io::handle and returns them.
+// Reads records from an io::handle and returns them. The result must be freed
+// using [[freerecords]].
export fn readrecords(r: io::handle) ([][]str | io::error | utf8::invalid) = {
const sc = bufio::newscanner(r);
defer bufio::finish(&sc);