Merge pull request #7693 from AndrolGenhald/improve-invalid-global-do…

…cumentation
vimeo · Feb 18, 2022 · 2d83a4b · 2d83a4b
2 parents 2e2099e + c1077f3
commit 2d83a4b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/running_psalm/issues/InvalidGlobal.md b/docs/running_psalm/issues/InvalidGlobal.md
@@ -1,9 +1,13 @@
 # InvalidGlobal
 
-Emitted when there's a reference to the global keyword where it's not expected
+Emitted when there's a reference to the global keyword where it's not expected.
 
 ```php
 <?php
 
 global $e;
 ```
+
+If the file is included from a non-global scope this issue will have to be suppressed. See
+[Config suppression](../dealing_with_code_issues/#suppressing-issues) for how to suppress this at the file or directory
+level.
diff --git a/src/Psalm/Internal/Analyzer/Statements/GlobalAnalyzer.php b/src/Psalm/Internal/Analyzer/Statements/GlobalAnalyzer.php
@@ -30,7 +30,7 @@ public static function analyze(
         if (!$context->collect_initializations && !$global_context) {
             IssueBuffer::maybeAdd(
                 new InvalidGlobal(
-                    'Cannot use global scope here',
+                    'Cannot use global scope here (unless this file is included from a non-global scope)',
                     new CodeLocation($statements_analyzer, $stmt)
                 ),
                 $statements_analyzer->getSource()->getSuppressedIssues()