Merge pull request #107 from php-http/promise_result

joelwurtz · joelwurtz · commit 6608e8cac176 · 2016-01-25T23:46:01.000+01:00
Add Promise return type doc in Async client
diff --git a/src/HttpAsyncClient.php b/src/HttpAsyncClient.php
@@ -19,7 +19,7 @@ interface HttpAsyncClient
      *
      * @param RequestInterface $request
      *
-     * @return Promise
+     * @return Promise Resolves a PSR-7 Response or fails with an Http\Client\Exception.
      *
      * @throws \Exception If processing the request is impossible (eg. bad configuration).
      */

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ interface HttpAsyncClient`
`19`	`19`	`*`
`20`	`20`	`* @param RequestInterface $request`
`21`	`21`	`*`
`22`		`- * @return Promise`
	`22`	`+ * @return Promise Resolves a PSR-7 Response or fails with an Http\Client\Exception.`
`23`	`23`	`*`
`24`	`24`	`* @throws \Exception If processing the request is impossible (eg. bad configuration).`
`25`	`25`	`*/`