Skip to content

Documented all $id parameters in API classes as int #640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 25, 2017
Merged

Documented all $id parameters in API classes as int #640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions lib/Github/Api/CurrentUser/Notifications.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand All @@ -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
*/
Expand All @@ -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
*/
Expand All @@ -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
*/
Expand All @@ -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
*/
Expand Down
4 changes: 2 additions & 2 deletions lib/Github/Api/CurrentUser/PublicKeys.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public function all()
*
* @link https://developer.github.com/v3/users/keys/
*
* @param string $id
* @param int $id
*
* @return array
*/
Expand Down Expand Up @@ -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
*/
Expand Down
4 changes: 2 additions & 2 deletions lib/Github/Api/Deployment.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions lib/Github/Api/Issue.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down Expand Up @@ -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
*
Expand All @@ -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
*/
Expand All @@ -177,7 +177,7 @@ public function lock($username, $repository, $id)
*
* @param string $username
* @param string $repository
* @param string $id
* @param int $id
*
* @return string
*/
Expand Down
4 changes: 2 additions & 2 deletions lib/Github/Api/PullRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand All @@ -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
*/
Expand Down