Skip to content

Commit

Permalink
minor #988 Fix incorrect public key documentation (acrobat)
Browse files Browse the repository at this point in the history
This PR was merged into the 2.x branch.

Discussion
----------

Fixes #789 

Commits
-------

2cc80c5 Fix incorrect public key documentation
  • Loading branch information
acrobat authored Mar 28, 2021
2 parents 83ee835 + 2cc80c5 commit 87db975
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/currentuser/publickeys.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ Wraps [GitHub User Public Keys API](https://developer.github.com/v3/users/keys/#
### List your public keys

```php
$keys = $client->user()->keys()->all();
$keys = $client->me()->keys()->all();
```

Returns a list of public keys for the authenticated user.

### Shows a public key for the authenticated user.

```php
$key = $client->user()->keys()->show(1234);
$key = $client->me()->keys()->show(1234);
```

### Add a public key to the authenticated user.

> Requires [authentication](../security.md).
```php
$key = $client->user()->keys()->create(array('title' => 'key title', 'key' => 12345));
$key = $client->me()->keys()->create(array('title' => 'key title', 'key' => 12345));
```

Adds a key with title 'key title' to the authenticated user and returns a the created key for the user.
Expand All @@ -32,5 +32,5 @@ Adds a key with title 'key title' to the authenticated user and returns a the cr
> Requires [authentication](../security.md).
```php
$client->user()->keys()->remove(12345);
$client->me()->keys()->remove(12345);
```

0 comments on commit 87db975

Please sign in to comment.