commands: NewRequest: Documented error case

abb8374d · Matt Bell · 3c5bfcec · abb8374d
Commit abb8374d authored 10 years ago by Matt Bell
Hide whitespace changes
Inline Side-by-side

Showing with 1 addition and 0 deletions

commands/request.go commands/request.go +1 -0

No files found.
--- a/commands/request.go
+++ b/commands/request.go
@@ -257,6 +257,7 @@ func NewEmptyRequest() (Request, error) {
 }

 // NewRequest returns a request initialized with given arguments
+// An non-nil error will be returned if the provided option values are invalid
 func NewRequest(path []string, opts optMap, args []interface{}, cmd *Command, optDefs map[string]Option) (Request, error) {
 	if path == nil {
 		path = make([]string, 0)