docs: update doc strings for sink read functions

pull/240/head
sammyette 2023-04-14 00:45:30 -04:00
parent f5fe85ea2e
commit f9546e10e4
Signed by: sammyette
GPG Key ID: 904FC49417B44DCD
1 changed files with 3 additions and 3 deletions

View File

@ -69,9 +69,9 @@ func setupSinkType(rtm *rt.Runtime) {
// #member // #member
// read() -> string // readAll() -> string
// --- @returns 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) { func luaSinkReadAll(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
if err := c.Check1Arg(); err != nil { if err := c.Check1Arg(); err != nil {
return nil, err return nil, err
@ -102,7 +102,7 @@ func luaSinkReadAll(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
// #member // #member
// read() -> string // read() -> string
// --- @returns 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) { func luaSinkRead(t *rt.Thread, c *rt.GoCont) (rt.Cont, error) {
if err := c.Check1Arg(); err != nil { if err := c.Check1Arg(); err != nil {
return nil, err return nil, err