From 75c3b955177f6453b50d447dcb6925d2d23474cb Mon Sep 17 00:00:00 2001 From: sammyette Date: Sat, 27 Apr 2024 20:30:47 -0400 Subject: [PATCH] docs(commander): detail about sinks.input --- golibs/commander/commander.go | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/golibs/commander/commander.go b/golibs/commander/commander.go index ea2da7a..f4d588d 100644 --- a/golibs/commander/commander.go +++ b/golibs/commander/commander.go @@ -17,8 +17,11 @@ In this example, a command with the name of `hello` is created that will print `Hello world!` to output. One question you may have is: What is the `sinks` parameter? -The `sinks` parameter is a table with 3 keys: `in`, `out`, -and `err`. All of them are a @Sink. +The `sinks` parameter is a table with 3 keys: `input`, `out`, and `err`. +There is an `in` alias to `input`, but it requires using the string accessor syntax (`sinks['in']`) +as `in` is also a Lua keyword, so `input` is preferred for use. +All of them are a @Sink. +In the future, `sinks.in` will be removed. - `in` is the standard input. You may use the read functions on this sink to get input from the user.