Update src/Psalm/Plugin/EventHandler/BeforeAddIssueInterface.php

Co-authored-by: Bruce Weirdan <weirdan@gmail.com>
vimeo · Jan 31, 2022 · ffafccc · ffafccc
1 parent 995ecd0
commit ffafccc
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/Psalm/Plugin/EventHandler/BeforeAddIssueInterface.php b/src/Psalm/Plugin/EventHandler/BeforeAddIssueInterface.php
@@ -11,6 +11,10 @@ interface BeforeAddIssueInterface
     /**
      * Called before adding a code issue.
      *
+     * Note that event handlers are called in the order they were registered, and thus
+     * the handler registered earlier may prevent subsequent handlers from running by
+     * returning a boolean value.
+     *
      * @param BeforeAddIssueEvent $event
      * @return null|bool $event How and whether to continue:
      *  + `null` continues with next event handler