From: Coleman Watts <coleman@civicrm.org>
Date: Sat, 14 Sep 2019 14:22:03 +0000 (-0400)
Subject: Reword event docs to clarify priority vs weight
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=855d0fe0ac956199e3e6f10c4f22d4e12ceaf11c;p=civicrm-core.git

Reword event docs to clarify priority vs weight
---

diff --git a/Civi/API/Events.php b/Civi/API/Events.php
index 9051f75d2b..25907b71c9 100644
--- a/Civi/API/Events.php
+++ b/Civi/API/Events.php
@@ -33,8 +33,7 @@ namespace Civi\API;
  * event is dispatched.
  *
  * Event subscribers which are concerned about the order of execution should assign
- * a weight to their subscription (such as W_EARLY, W_MIDDLE, or W_LATE).
- * W_LATE).
+ * a priority to their subscription (such as W_EARLY, W_MIDDLE, or W_LATE).
  */
 class Events {
 
@@ -78,17 +77,17 @@ class Events {
   const EXCEPTION = 'civi.api.exception';
 
   /**
-   * Weight - Early
+   * Priority - Higher numbers execute earlier
    */
   const W_EARLY = 100;
 
   /**
-   * Weight - Middle
+   * Priority - Middle
    */
   const W_MIDDLE = 0;
 
   /**
-   * Weight - Late
+   * Priority - Lower numbers execute later
    */
   const W_LATE = -100;