Skip to content

Commit d765ca4

Browse files
committed
Fixed not clear documentation
1 parent 7574e92 commit d765ca4

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

doc/result_pager.md

Lines changed: 17 additions & 6 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 a organization
77

88
```php
99
$client = new Github\Client();
@@ -15,7 +15,14 @@ $parameters = array('github');
1515
$result = $paginator->fetchAll($organizationApi, 'repositories', $parameters);
1616
```
1717

18-
Get the first page
18+
Parameters of the `fetchAll` method:
19+
20+
* The API object you're working with
21+
* The method of the API object you're using
22+
* The parameters of the method
23+
24+
#### Get the first page
25+
1926
```php
2027
$client = new Github\Client();
2128

@@ -26,22 +33,26 @@ $parameters = array('github');
2633
$result = $paginator->fetch($organizationApi, 'repositories', $parameters);
2734
```
2835

29-
Check for a next page:
36+
#### Check for a next page:
37+
3038
```php
3139
$paginator->hasNext();
3240
```
3341

34-
Get next page:
42+
#### Get next page:
43+
3544
```php
3645
$paginator->fetchNext();
3746
```
3847

39-
Check for previous page:
48+
#### Check for previous page:
49+
4050
```php
4151
$paginator->hasPrevious();
4252
```
4353

44-
Get previous page:
54+
#### Get previous page:
55+
4556
```php
4657
$paginator->fetchPrevious();
4758
```

0 commit comments

Comments
 (0)