minor #1060 Updates ReviewRequest Create method to return type Array (ejntaylor)

acrobat · web-flow · commit 1f31aa177521 · 2022-04-13T10:34:13.000+02:00
This PR was merged into the 3.4.x-dev branch. Discussion ---------- This query returns an array and not a string. I have updated to reflect this. Specific docs link added in docblock too. Commits ------- 8ab22f6 Updates ReviewRequest Create with type Array
diff --git a/lib/Github/Api/PullRequest/ReviewRequest.php b/lib/Github/Api/PullRequest/ReviewRequest.php
@@ -39,15 +39,15 @@ public function all($username, $repository, $pullRequest, array $params = [])
     }
 
     /**
-     * @link https://developer.github.com/v3/pulls/review_requests/#create-a-review-request
+     * @link https://docs.github.com/en/rest/reference/pulls#request-reviewers-for-a-pull-request
      *
      * @param string $username
      * @param string $repository
      * @param int    $pullRequest
      * @param array  $reviewers
      * @param array  $teamReviewers
      *
-     * @return string
+     * @return array
      */
     public function create($username, $repository, $pullRequest, array $reviewers = [], array $teamReviewers = [])
     {

Original file line number	Diff line number	Diff line change
`@@ -39,15 +39,15 @@ public function all($username, $repository, $pullRequest, array $params = [])`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`/**`
`42`		`- * @link https://developer.github.com/v3/pulls/review_requests/#create-a-review-request`
	`42`	`+ * @link https://docs.github.com/en/rest/reference/pulls#request-reviewers-for-a-pull-request`
`43`	`43`	`*`
`44`	`44`	`* @param string $username`
`45`	`45`	`* @param string $repository`
`46`	`46`	`* @param int $pullRequest`
`47`	`47`	`* @param array $reviewers`
`48`	`48`	`* @param array $teamReviewers`
`49`	`49`	`*`
`50`		`- * @return string`
	`50`	`+ * @return array`
`51`	`51`	`*/`
`52`	`52`	`public function create($username, $repository, $pullRequest, array $reviewers = [], array $teamReviewers = [])`
`53`	`53`	`{`