From e93b97aa88cbec8b026994b715809ad14a106e1f Mon Sep 17 00:00:00 2001
From: Julian Hurst <ark@mansus.space>
Date: Fri, 15 Nov 2024 01:14:07 +0100
Subject: tsv: Improve readrecords doc

---
 format/tsv/reader.ha | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

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);
-- 
cgit v1.2.3