Merge pull request #3382 from keks/feat/command.run-docs

Add docs for `"commands".Command.Run`
ipfs · Nov 15, 2016 · bbd7ad2 · bbd7ad2
2 parents bc21966 + 1a3fa80
commit bbd7ad2
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/commands/command.go b/commands/command.go
@@ -52,9 +52,14 @@ type HelpText struct {
 // Command is a runnable command, with input arguments and options (flags).
 // It can also have Subcommands, to group units of work into sets.
 type Command struct {
-	Options    []Option
-	Arguments  []Argument
-	PreRun     func(req Request) error
+	Options   []Option
+	Arguments []Argument
+	PreRun    func(req Request) error
+
+	// Run is the function that processes the request to generate a response.
+	// Note that when executing the command over the HTTP API you can only read
+	// after writing when using multipart requests. The request body will not be
+	// available for reading after the HTTP connection has been written to.
 	Run        Function
 	PostRun    Function
 	Marshalers map[EncodingType]Marshaler