From 116322f2f94b1b93a5ef7eb7138b2d3ea0bc778c Mon Sep 17 00:00:00 2001 From: Sergei Morozov Date: Tue, 24 Oct 2017 20:48:54 -0700 Subject: [PATCH] Documented all $id parameters in API classes as int --- lib/Github/Api/CurrentUser/Notifications.php | 14 +++++++------- lib/Github/Api/CurrentUser/PublicKeys.php | 4 ++-- lib/Github/Api/Deployment.php | 4 ++-- lib/Github/Api/Issue.php | 8 ++++---- lib/Github/Api/PullRequest.php | 4 ++-- 5 files changed, 17 insertions(+), 17 deletions(-) diff --git a/lib/Github/Api/CurrentUser/Notifications.php b/lib/Github/Api/CurrentUser/Notifications.php index ccc2af2aad5..0e9f4c2d278 100644 --- a/lib/Github/Api/CurrentUser/Notifications.php +++ b/lib/Github/Api/CurrentUser/Notifications.php @@ -75,8 +75,8 @@ public function markAsReadInRepository($username, $repository, array $params = a * * @link http://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read * - * @param string $id the notification number - * @param array $params + * @param int $id the notification number + * @param array $params * * @return array */ @@ -90,7 +90,7 @@ public function markAsRead($id, array $params) * * @link http://developer.github.com/v3/activity/notifications/#view-a-single-thread * - * @param string $id the notification number + * @param int $id the notification number * * @return array */ @@ -104,7 +104,7 @@ public function show($id) * * @link http://developer.github.com/v3/activity/notifications/#get-a-thread-subscription * - * @param string $id the notification number + * @param int $id the notification number * * @return array */ @@ -118,8 +118,8 @@ public function showSubscription($id) * * @link http://developer.github.com/v3/activity/notifications/#set-a-thread-subscription * - * @param string $id the notification number - * @param array $params + * @param int $id the notification number + * @param array $params * * @return array */ @@ -133,7 +133,7 @@ public function createSubscription($id, array $params) * * @link http://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription * - * @param string $id the notification number + * @param int $id the notification number * * @return array */ diff --git a/lib/Github/Api/CurrentUser/PublicKeys.php b/lib/Github/Api/CurrentUser/PublicKeys.php index 418e78b8639..a09a08305ac 100644 --- a/lib/Github/Api/CurrentUser/PublicKeys.php +++ b/lib/Github/Api/CurrentUser/PublicKeys.php @@ -28,7 +28,7 @@ public function all() * * @link https://developer.github.com/v3/users/keys/ * - * @param string $id + * @param int $id * * @return array */ @@ -62,7 +62,7 @@ public function create(array $params) * * @link https://developer.github.com/v3/users/keys/ * - * @param string $id + * @param int $id * * @return array */ diff --git a/lib/Github/Api/Deployment.php b/lib/Github/Api/Deployment.php index 265be431b74..e7d4c95b5e2 100644 --- a/lib/Github/Api/Deployment.php +++ b/lib/Github/Api/Deployment.php @@ -68,8 +68,8 @@ public function create($username, $repository, array $params) * * @param string $username the username * @param string $repository the repository - * @param string $id the deployment number - * @param array $params The information about the deployment update. + * @param int $id the deployment number + * @param array $params The information about the deployment update. * Must include a "state" field of pending, success, error, or failure. * May also be given a target_url and description, ßee link for more details. * @return array information about the deployment diff --git a/lib/Github/Api/Issue.php b/lib/Github/Api/Issue.php index 1ec7e79e89c..537f7b8ed00 100644 --- a/lib/Github/Api/Issue.php +++ b/lib/Github/Api/Issue.php @@ -104,7 +104,7 @@ public function org($organization, $state, array $params = array()) * * @param string $username the username * @param string $repository the repository - * @param string $id the issue number + * @param int $id the issue number * * @return array information about the issue */ @@ -143,7 +143,7 @@ public function create($username, $repository, array $params) * * @param string $username the username * @param string $repository the repository - * @param string $id the issue number + * @param int $id the issue number * @param array $params key=>value user attributes to update. * key can be title or body * @@ -161,7 +161,7 @@ public function update($username, $repository, $id, array $params) * * @param string $username * @param string $repository - * @param string $id + * @param int $id * * @return string */ @@ -177,7 +177,7 @@ public function lock($username, $repository, $id) * * @param string $username * @param string $repository - * @param string $id + * @param int $id * * @return string */ diff --git a/lib/Github/Api/PullRequest.php b/lib/Github/Api/PullRequest.php index df8a42f1109..89a48c7c9d3 100644 --- a/lib/Github/Api/PullRequest.php +++ b/lib/Github/Api/PullRequest.php @@ -75,7 +75,7 @@ public function all($username, $repository, array $params = array()) * * @param string $username the username * @param string $repository the repository - * @param string $id the ID of the pull request for which details are retrieved + * @param int $id the ID of the pull request for which details are retrieved * * @return array|string pull request details */ @@ -101,7 +101,7 @@ public function files($username, $repository, $id) * * @param string $username the username * @param string $repository the repository - * @param string $id the ID of the pull request for which statuses are retrieved + * @param int $id the ID of the pull request for which statuses are retrieved * * @return array array of statuses for the project */