Skip to content

Commit d330747

Browse files
committed
Fixed several typos and grammar errors
1 parent 3467a34 commit d330747

15 files changed

+33
-33
lines changed

doc/activity.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Returns an array of watched repos.
2424

2525
> *** Requires [authentication](security.md). ***
2626
27-
### Get repos that a authenticated user has starred
27+
### Get repos that an authenticated user has starred
2828

2929
```php
3030
$activity = $client->api('current_user')->starring()->all();
@@ -38,7 +38,7 @@ $activity = $client->api('user')->events('ornicar');
3838
```
3939
Returns an array of private and public events created for all repos related to the user.
4040

41-
### Get repos that a authenticated user has starred with creation date
41+
### Get repos that an authenticated user has starred with creation date
4242

4343
Support for getting the star creation timestamp in the response, using the custom `Accept: application/vnd.github.v3.star+json` header.
4444

@@ -75,7 +75,7 @@ $activity = $client->api('current_user')->starring()->unstar($owner, $repo);
7575
Throws an Exception in case of failure or NULL in case of success.
7676

7777

78-
### Get repos that a authenticated user is watching
78+
### Get repos that an authenticated user is watching
7979

8080
```php
8181
$activity = $client->api('current_user')->watchers()->all();

doc/caching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ $client->removeCache();
2626
```
2727

2828
Using cache, the client will get cached responses if resources haven't changed since last time,
29-
**without** reaching the `X-Rate-Limit` [imposed by github](http://developer.github.com/v3/#rate-limiting).
29+
**without** reaching the `X-Rate-Limit` [imposed by GitHub](http://developer.github.com/v3/#rate-limiting).
3030

doc/currentuser/publickeys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ $key = $client->me()->keys()->show(1234);
2525
$key = $client->me()->keys()->create(array('title' => 'key title', 'key' => 12345));
2626
```
2727

28-
Adds a key with title 'key title' to the authenticated user and returns a the created key for the user.
28+
Adds a key with title 'key title' to the authenticated user and returns the created key for the user.
2929

3030
### Remove a public key from the authenticated user.
3131

doc/customize.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ To use the symfony http client
2222
composer require symfony/http-client nyholm/psr7
2323
```
2424

25-
To set up the github client with this http client
25+
To set up the GitHub client with this http client
2626

2727
```php
2828
use Github\Client;

doc/graphql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ $rateLimits = $client->api('graphql')->execute($query);
1111

1212
#### Authentication
1313

14-
To use [GitHub v4 API (GraphQL API)](http://developer.github.com/v4/) requests must [authenticated](security.md).
14+
To use [GitHub v4 API (GraphQL API)](http://developer.github.com/v4/) requests must [authenticate](security.md).
1515

1616
```php
1717
$client->authenticate($token, null, Github\AuthMethod::ACCESS_TOKEN);

doc/project/projects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## Repo / Projects API
22
[Back to the "Repos API"](../) | [Back to the navigation](../README.md)
33

4-
This api is currently only available to developers in Early Access. To access the API during the Early Access period,
4+
This api is currently only available to developers in Early Access. To access the API during the Early Access period,
55
you must provide a custom media type in the Accept header.
66

7-
Both repositories and organisations have projects. The api is only different for gettings all or a single project.
7+
Both repositories and organisations have projects. The api is only different for getting all or a single project.
88
All the example use the repository projects api but this also works form the organization api (`$client->api('org_projects')`)
99

1010
```php

doc/pull_request/comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ $comment = $client->api('pull_request')->comments()->update('KnpLabs', 'php-gith
6767

6868
This returns the details of the updated comment.
6969

70-
### Remove a review comment from an pull request
70+
### Remove a review comment from a pull request
7171

7272
> Requires [authentication](../security.md).
7373

doc/repo/hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Repo / Hooks API
22
[Back to the "Repos API"](../repos.md) | [Back to the navigation](../README.md)
33

4-
For extended info see the [Github documentation](https://docs.github.com/en/rest/reference/repos#webhooks)
4+
For extended info see the [GitHub documentation](https://docs.github.com/en/rest/reference/repos#webhooks)
55

66
### List repository webhooks
77

doc/repos.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -310,8 +310,8 @@ $activity = $client->api('repo')->activity('ornicar', 'php-github-api');
310310
Returns an array of commit activity group by week.
311311

312312
### `Moved` repositories
313-
Github repositories can be moved to another org/user, but it remains the `id`.
314-
In case if you can't no more find repo, you can retrieve it by `id`:
313+
GitHub repositories can be moved to another org/user, but it remains the `id`.
314+
In case you can't find the repo anymore, you can retrieve it by `id`:
315315

316316
```php
317317
use Github\HttpClient\Message\ResponseMediator;
@@ -365,7 +365,7 @@ $repo = $client->api('repo')->transfer('KnpLabs', 'php-github-api', 'github', [1
365365

366366
### Create a repository dispatch event
367367

368-
Example when you want to configure custom github action workflows.
368+
Example when you want to configure custom GitHub action workflows.
369369

370370
```php
371371
$client->api('repo')->dispatch('KnpLabs', 'php-github-api', 'acme-event', ['foo'=>'bar']);

doc/request_response_info.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
### Get response headers
55

6-
Get the repsonse header for the latest request
6+
Get the response header for the latest request
77

88
```
99
$headers = $githubClient->getLastResponse()->getHeaders();

doc/result_pager.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
### Usage examples
55

6-
#### Get all repositories of a organization
6+
#### Get all repositories of an organization
77

88
```php
99
$client = new Github\Client();
@@ -21,7 +21,7 @@ Parameters of the `fetchAll` method:
2121
* The method of the API object you're using
2222
* The parameters of the method
2323

24-
Parameters are passed to the API method via [call_user_func_array](https://www.php.net/manual/en/function.call-user-func-array.php).
24+
Parameters are passed to the API method via [call_user_func_array](https://www.php.net/manual/en/function.call-user-func-array.php).
2525

2626
```php
2727
$parameters = array('github', 'all', 1); // $organization, $type, $page

doc/security.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ further requests are done as the given user.
3333
### Authenticating as an Integration
3434

3535
To authenticate as an integration you need to supply a JSON Web Token with `Github\AuthMethod::JWT` to request
36-
and installation access token which is then usable with `Github\AuthMethod::ACCESS_TOKEN`. [Github´s integration
36+
and installation access token which is then usable with `Github\AuthMethod::ACCESS_TOKEN`. [GitHub´s integration
3737
authentication docs](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps/#authenticating-as-a-github-app) describe the flow in detail.
3838
It´s important for integration requests to use the custom Accept header `application/vnd.github.machine-man-preview`.
3939

@@ -67,5 +67,5 @@ $jwt = $config->builder(ChainedFormatter::withUnixTimestampDates())
6767
$github->authenticate($jwt->toString(), null, Github\AuthMethod::JWT);
6868
```
6969

70-
The `$integrationId` you can find in the about section of your github app.
70+
The `$integrationId` you can find in the about section of your GitHub app.
7171
The `$installationId` you can find by installing the app and using the id in the url.

doc/testing.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Run Test Suite
66

7-
The code is unit tested, there are also some functional tests. To run tests on
7+
The code is unit tested, there are also some functional tests. To run tests on
88
your machine, from a CLI, run
99

1010
```bash
@@ -14,12 +14,12 @@ $ phpunit
1414

1515
### Write tests
1616

17-
It is always great if someone wants to contribute and extend the functionality of
18-
the API client. But all new features must be properly tested. To test a new API
19-
function, one should test its communication with the HTTP client. The code should
20-
never make an actual call to Github. Testing could easily be done with mocking.
17+
It is always great if someone wants to contribute and extend the functionality of
18+
the API client. But all new features must be properly tested. To test a new API
19+
function, one should test its communication with the HTTP client. The code should
20+
never make an actual call to GitHub. Testing could easily be done with mocking.
2121

22-
If you want to write test for the function that shows you comments to a gist.
22+
If you want to write test for the function that shows you comments to a gist.
2323

2424
```php
2525
class Comments extends AbstractApi
@@ -32,7 +32,7 @@ class Comments extends AbstractApi
3232
}
3333
```
3434

35-
The test will look like this:
35+
The test will look like this:
3636

3737
```php
3838
use Github\Tests\Api\TestCase;
@@ -51,22 +51,22 @@ class CommentsTest extends TestCase
5151

5252
// Get the API mock (see "getApiClass" below).
5353
$api = $this->getApiMock();
54-
54+
5555
$api->expects($this->once()) // Expect one call
5656
->method('get') // A GET request
5757
->with('/gists/123/comments/456') // URI should be "/gists/123/comments/456"
5858
->will($this->returnValue($expectedValue)); // Should return the "Server response"
5959

6060
// Call Comments::show
6161
$result = $api->show(123, 456);
62-
63-
// Verify that the result is the "Server response" as we expect.
62+
63+
// Verify that the result is the "Server response" as we expect.
6464
$this->assertEquals($expectedValue, $result);
6565
}
66-
66+
6767
protected function getApiClass()
6868
{
69-
// Tell the "getAPIMock" what class to mock.
69+
// Tell the "getAPIMock" what class to mock.
7070
return \Github\Api\Gist\Comments::class;
7171
}
7272
}

doc/two_factor_authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Two factor authentication
1+
## Two-factor authentication
22
[Back to the navigation](README.md)
33

44

doc/users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ $user = $client->api('user')->show('KnpLabs');
3333
Returns an array of information about the user.
3434

3535

36-
You can also use the User ID, but it will use an undocumented Github API
36+
You can also use the User ID, but it will use an undocumented GitHub API
3737

3838
```php
3939
$user = $client->api('user')->showById(202732);

0 commit comments

Comments
 (0)