summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShulhan <ms@kilabit.info>2023-09-22 02:21:35 +0700
committerShulhan <ms@kilabit.info>2023-09-22 02:21:35 +0700
commit0d0217abcd91f9c597eaf44cb639191e42290b5d (patch)
treeb94b37fe0eb11264e1ea52c9eeea6bbed95d2992
parentac811b84af2461539d6b04c3d95eed8e5438ec25 (diff)
downloadawwan-0d0217abcd91f9c597eaf44cb639191e42290b5d.tar.xz
all: update the comment on Request type
This move the comment related to non-exported fields inside the struct instead of top.
-rw-r--r--request.go10
1 files changed, 5 insertions, 5 deletions
diff --git a/request.go b/request.go
index 4c2ddf9..52cda4e 100644
--- a/request.go
+++ b/request.go
@@ -9,12 +9,12 @@ import (
)
// Request for executing local or remote script.
-// Each request define the script file to be executed and the line number
-// range in form of BeginAt and EndAt.
-//
-// Each request may set the Writer where the command output and error will be
-// written. If its nil, it will default to os.Stdout and os.Stderr.
+// Each request define the Mode of execution, Script file to be executed,
+// and the lineRange -- list of line numbers to be executed.
type Request struct {
+ // Each request may set the Writer where the command output and
+ // error will be written.
+ // If its nil, it will default to os.Stdout and os.Stderr.
stdout io.Writer
stderr io.Writer
scriptPath string // The actual or cleaned up path of the Script.