Merge pull request #135 from digitalkaoz/patch-1

corrected Return Annotations
KnpLabs · Jun 17, 2014 · ac28d13 · ac28d13
2 parents 513266b + 3e5e7d6
commit ac28d13
Showing 1 changed file with 7 additions and 6 deletions.
diff --git a/lib/Github/HttpClient/HttpClientInterface.php b/lib/Github/HttpClient/HttpClientInterface.php
@@ -3,6 +3,7 @@
 namespace Github\HttpClient;
 
 use Github\Exception\InvalidArgumentException;
+use Guzzle\Http\Message\Response;
 
 /**
  * Performs requests on GitHub API. API documentation should be self-explanatory.
@@ -18,7 +19,7 @@ interface HttpClientInterface
      * @param array  $parameters GET Parameters
      * @param array  $headers    Reconfigure the request headers for this call only
      *
-     * @return array Data
+     * @return Response
      */
     public function get($path, array $parameters = array(), array $headers = array());
 
@@ -29,7 +30,7 @@ public function get($path, array $parameters = array(), array $headers = array()
      * @param mixed  $body       Request body
      * @param array  $headers    Reconfigure the request headers for this call only
      *
-     * @return array Data
+     * @return Response
      */
     public function post($path, $body = null, array $headers = array());
 
@@ -41,7 +42,7 @@ public function post($path, $body = null, array $headers = array());
      * @param array  $headers    Reconfigure the request headers for this call only
      *
      * @internal param array $parameters Request body
-     * @return array Data
+     * @return Response
      */
     public function patch($path, $body = null, array $headers = array());
 
@@ -52,7 +53,7 @@ public function patch($path, $body = null, array $headers = array());
      * @param mixed  $body       Request body
      * @param array  $headers    Reconfigure the request headers for this call only
      *
-     * @return array Data
+     * @return Response
      */
     public function put($path, $body, array $headers = array());
 
@@ -63,7 +64,7 @@ public function put($path, $body, array $headers = array());
      * @param mixed  $body       Request body
      * @param array  $headers    Reconfigure the request headers for this call only
      *
-     * @return array Data
+     * @return Response
      */
     public function delete($path, $body = null, array $headers = array());
 
@@ -76,7 +77,7 @@ public function delete($path, $body = null, array $headers = array());
      * @param string $httpMethod HTTP method to use
      * @param array  $headers    Request headers
      *
-     * @return array Data
+     * @return Response
      */
     public function request($path, $body, $httpMethod = 'GET', array $headers = array());