internal/sandbox: improve docstrings
Change-Id: I2ebea341da85c0564fe1d6bd8b22af6f48a2c83b
Reviewed-on: https://go-review.googlesource.com/c/pkgsite-metrics/+/481235
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Jonathan Amsterdam <jba@google.com>
Run-TryBot: Zvonimir Pavlinovic <zpavlinovic@google.com>
diff --git a/internal/sandbox/runner.go b/internal/sandbox/runner.go
index 1b0f362..348a097 100644
--- a/internal/sandbox/runner.go
+++ b/internal/sandbox/runner.go
@@ -4,12 +4,12 @@
//go:build ignore
-// This program runs another program provided on standard input,
-// prints its standard output, then terminates. It logs to stderr.
+// Package main defines a program that runs another program
+// provided on standard input, prints its standard output, then
+// terminates. It logs to stderr.
//
-// It first reads all of standard input, then splits it into words on
-// whitespace. It treats the first word as the program path and the rest as
-// arguments.
+// The input is expected to be json content encoding an exec.Cmd
+// structure extended with a boolean AppendToEnv field.
package main
import (
