From f9546e10e499ac356a99bdc0b423edb1fbcd03ef Mon Sep 17 00:00:00 2001 From: sammyette Date: Fri, 14 Apr 2023 00:45:30 -0400 Subject: [PATCH] docs: update doc strings for sink read functions --- sink.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sink.go b/sink.go index 62e9bec..3aa5507 100644 --- a/sink.go +++ b/sink.go @@ -69,9 +69,9 @@ func setupSinkType(rtm *rt.Runtime) { // #member -// read() -> string +// readAll() -> string // --- @returns string -// Reads input from the sink. +// Reads all input from the sink. func luaSinkReadAll(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err @@ -102,7 +102,7 @@ func luaSinkReadAll(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { // #member // read() -> string // --- @returns string -// Reads input from the sink. +// Reads a liine of input from the sink. func luaSinkRead(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) { if err := c.Check1Arg(); err != nil { return nil, err