docs(commands) Type

bffcfa60 · Brian Tiger Chow · Juan Batiz-Benet · 89131d64 · bffcfa60
Commit bffcfa60 authored Nov 11, 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

command.go command.go +6 -0

No files found.
--- a/command.go
+++ b/command.go
@@ -40,6 +40,12 @@ type Command struct {
 	Arguments   []Argument
 	Run         Function
 	Marshallers map[EncodingType]Marshaller
+
+	// Type describes the type of the output of the Command's Run Function.
+	// Precisely, the value of Type is an instance of the return type of the
+	// Run Function.
+	//
+	// ie. If command Run returns &Block{}, then Command.Type == &Block{}
 	Type        interface{}
 	Subcommands map[string]*Command
 }