8000 Merge pull request #249 from clue-labs/docs · reactphp/event-loop@361e9ad · GitHub
[go: up one dir, main page]

Skip to content

Commit 361e9ad

Browse files
authored
Merge pull request #249 from clue-labs/docs
Minor documentation improvements
2 parents a8d1d39 + a35d6d4 commit 361e9ad

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
@@ -84,8 +84,8 @@ See also the [examples](examples).
8484

8585
## Usage
8686

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

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

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

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

441441
This event loop is known to trigger a readable listener only if
442442
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)
0