Improve enable() doc and mention it also in the class level phpdoc block

kelunik · trowski · commit 82c05abff4dd · 2017-02-21T12:03:57.000-06:00
diff --git a/src/Loop.php b/src/Loop.php
@@ -271,9 +271,8 @@ public static function onSignal($signo, callable $callback, $data = null)
     /**
      * Enable a watcher.
      *
-     * Watchers (enabling or new watchers) MUST immediately be marked as enabled, but only be activated (i.e. callbacks
-     * can be called) right before the next tick. Callbacks of watchers MUST not be called in the tick they were
-     * enabled.
+     * Watchers MUST immediately be marked as enabled, but only be activated (i.e. callbacks can be called) right before
+     * the next tick. Callbacks of watchers MUST NOT be called in the tick they were enabled.
      *
      * @param string $watcherId The watcher identifier.
      *
diff --git a/src/Loop/Driver.php b/src/Loop/Driver.php
@@ -5,7 +5,10 @@
 /**
  * Event loop driver which implements all basic operations to allow interoperability.
  *
- * Registered callbacks MUST NOT be called from a file with strict types enabled (`declare(strict_types=1)`).
+ * Watchers (enabled or new watchers) MUST immediately be marked as enabled, but only be activated (i.e. callbacks can
+ * be called) right before the next tick. Callbacks of watchers MUST NOT be called in the tick they were enabled.
+ *
+ * All registered callbacks MUST NOT be called from a file with strict types enabled (`declare(strict_types=1)`).
  */
 abstract class Driver
 {
@@ -143,9 +146,8 @@ abstract public function onSignal($signo, callable $callback, $data = null);
     /**
      * Enable a watcher.
      *
-     * Watchers (enabling or new watchers) MUST immediately be marked as enabled, but only be activated (i.e. callbacks
-     * can be called) right before the next tick. Callbacks of watchers MUST not be called in the tick they were
-     * enabled.
+     * Watchers MUST immediately be marked as enabled, but only be activated (i.e. callbacks can be called) right before
+     * the next tick. Callbacks of watchers MUST NOT be called in the tick they were enabled.
      *
      * @param string $watcherId The watcher identifier.
      *

Original file line number	Diff line number	Diff line change
`@@ -271,9 +271,8 @@ public static function onSignal($signo, callable $callback, $data = null)`
`271`	`271`	`/**`
`272`	`272`	`* Enable a watcher.`
`273`	`273`	`*`
`274`		`- * Watchers (enabling or new watchers) MUST immediately be marked as enabled, but only be activated (i.e. callbacks`
`275`		`- * can be called) right before the next tick. Callbacks of watchers MUST not be called in the tick they were`
`276`		`- * enabled.`
	`274`	`+ * Watchers MUST immediately be marked as enabled, but only be activated (i.e. callbacks can be called) right before`
	`275`	`+ * the next tick. Callbacks of watchers MUST NOT be called in the tick they were enabled.`
`277`	`276`	`*`
`278`	`277`	`* @param string $watcherId The watcher identifier.`
`279`	`278`	`*`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,10 @@`
`5`	`5`	`/**`
`6`	`6`	`* Event loop driver which implements all basic operations to allow interoperability.`
`7`	`7`	`*`
`8`		- * Registered callbacks MUST NOT be called from a file with strict types enabled (`declare(strict_types=1)`).
	`8`	`+ * Watchers (enabled or new watchers) MUST immediately be marked as enabled, but only be activated (i.e. callbacks can`
	`9`	`+ * be called) right before the next tick. Callbacks of watchers MUST NOT be called in the tick they were enabled.`
	`10`	`+ *`
	`11`	+ * All registered callbacks MUST NOT be called from a file with strict types enabled (`declare(strict_types=1)`).
`9`	`12`	`*/`
`10`	`13`	`abstract class Driver`
`11`	`14`	`{`
`@@ -143,9 +146,8 @@ abstract public function onSignal($signo, callable $callback, $data = null);`
`143`	`146`	`/**`
`144`	`147`	`* Enable a watcher.`
`145`	`148`	`*`
`146`		`- * Watchers (enabling or new watchers) MUST immediately be marked as enabled, but only be activated (i.e. callbacks`
`147`		`- * can be called) right before the next tick. Callbacks of watchers MUST not be called in the tick they were`
`148`		`- * enabled.`
	`149`	`+ * Watchers MUST immediately be marked as enabled, but only be activated (i.e. callbacks can be called) right before`
	`150`	`+ * the next tick. Callbacks of watchers MUST NOT be called in the tick they were enabled.`
`149`	`151`	`*`
`150`	`152`	`* @param string $watcherId The watcher identifier.`
`151`	`153`	`*`