Skip to content

Commit a35d6d4

Browse files
committed
Minor documentation improvements
1 parent cd3f42b commit a35d6d4

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ See also the [examples](examples).
8383

8484
## Usage
8585

86-
As of `v1.2.0`, typical applications would use the [`Loop` object](#loop)
87-
to use the currently active event loop like this:
86+
Typical applications would use the [`Loop` class](#loop) to use the default
87+
event loop like this:
8888

8989
```php
9090
use React\EventLoop\Loop;
@@ -123,14 +123,14 @@ In both cases, the program would perform the exact same steps.
123123

124124
1. The event loop instance is created at the beginning of the program. This is
125125
implicitly done the first time you call the [`Loop` class](#loop) or
126-
explicitly when using the deprecated [`Factory::create() method`](#create)
126+
explicitly when using the deprecated [`Factory::create()` method](#create)
127127
(or manually instantiating any of the [loop implementations](#loop-implementations)).
128128
2. The event loop is used directly or passed as an instance to library and
129129
application code. In this example, a periodic timer is registered with the
130130
event loop which simply outputs `Tick` every fraction of a second until another
131131
timer stops the periodic timer after a second.
132132
3. The event loop is run at the end of the program. This is automatically done
133-
when using [`Loop` class](#loop) or explicitly with a single [`run()`](#run)
133+
when using the [`Loop` class](#loop) or explicitly with a single [`run()`](#run)
134134
call at the end of the program.
135135

136136
As of `v1.2.0`, we highly recommend using the [`Loop` class](#loop).
@@ -434,8 +434,8 @@ This event loop does only work with PHP 5.
434434
An [unofficial update](https://github.com/php/pecl-event-libevent/pull/2) for
435435
PHP 7 does exist, but it is known to cause regular crashes due to `SEGFAULT`s.
436436
To reiterate: Using this event loop on PHP 7 is not recommended.
437-
Accordingly, neither the [`Loop` object](#loop) nor the deprecated
438-
[`Factory`](#factory) will try to use this event loop on PHP 7.
437+
Accordingly, neither the [`Loop` class](#loop) nor the deprecated
438+
[`Factory` class](#factory) will try to use this event loop on PHP 7.
439439

440440
This event loop is known to trigger a readable listener only if
441441
the stream *becomes* readable (edge-triggered) and may not trigger if the

src/ExtLibeventLoop.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@
2020
* An [unofficial update](https://github.com/php/pecl-event-libevent/pull/2) for
2121
* PHP 7 does exist, but it is known to cause regular crashes due to `SEGFAULT`s.
2222
* To reiterate: Using this event loop on PHP 7 is not recommended.
23-
* Accordingly, neither the [`Loop` object](#loop) nor the deprecated
24-
* [`Factory`](#factory) will try to use this event loop on PHP 7.
23+
* Accordingly, neither the [`Loop` class](#loop) nor the deprecated
24+
* [`Factory` class](#factory) will try to use this event loop on PHP 7.
2525
*
2626
* This event loop is known to trigger a readable listener only if
2727
* the stream *becomes* readable (edge-triggered) and may not trigger if the

0 commit comments

Comments
 (0)