More legible event documentation

reactphp · Mar 3, 2017 · 1252b93 · 1252b93
1 parent c587d8b
commit 1252b93
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -21,7 +21,7 @@ This component depends on `événement`, which is an implementation of the
 * `data`: Emitted whenever data was read from the source
   with a single mixed argument for incoming data.
 * `end`: Emitted when the source has reached the `eof`.
-* `error`: Emitted when an error occurs.
+* `error`: Emitted when an error occurs
   with a single `Exception` argument for error instance.
 * `close`: Emitted when the connection is closed.
 

diff --git a/src/ReadableStreamInterface.php b/src/ReadableStreamInterface.php
@@ -5,9 +5,9 @@
 use Evenement\EventEmitterInterface;
 
 /**
- * @event data with single mixed argument for incoming data
+ * @event data with a single mixed argument for incoming data
  * @event end
- * @event error with single Exception argument for error instance
+ * @event error with a single Exception argument for error instance
  * @event close
  */
 interface ReadableStreamInterface extends EventEmitterInterface

diff --git a/src/WritableStreamInterface.php b/src/WritableStreamInterface.php
@@ -6,9 +6,9 @@
 
 /**
  * @event drain
- * @event error with single Exeption argument for error instance
+ * @event error with a single Exeption argument for error instance
  * @event close
- * @event pipe with single ReadableStreamInterface argument for source stream
+ * @event pipe with a single ReadableStreamInterface argument for source stream
  */
 interface WritableStreamInterface extends EventEmitterInterface
 {