docs(commands/request)

84f00147 · Brian Tiger Chow · Juan Batiz-Benet · 4c295937 · 84f00147
Commit 84f00147 authored Nov 12, 2014 by Brian Tiger Chow Committed by Juan Batiz-Benet Nov 14, 2014
Show whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

request.go request.go +6 -0

No files found.
--- a/request.go
+++ b/request.go
@@ -25,6 +25,12 @@ type Request interface {
 	Option(name string) *OptionValue
 	Options() optMap
 	SetOption(name string, val interface{})
+
+	// Arguments() returns user provided arguments as declared on the Command.
+	//
+	// NB: `io.Reader`s returned by Arguments() are owned by the library.
+	// Readers are not guaranteed to remain open after the Command's Run
+	// function returns.
 	Arguments() []interface{} // TODO: make argument value type instead of using interface{}
 	Context() *Context
 	SetContext(Context)