Add better docs to TypeComparisonResult

vimeo · Dec 19, 2021 · 06dd642 · 06dd642
1 parent 10aff07
commit 06dd642
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/Psalm/Internal/Type/Comparator/TypeComparisonResult.php b/src/Psalm/Internal/Type/Comparator/TypeComparisonResult.php
@@ -7,7 +7,12 @@
 
 class TypeComparisonResult
 {
-    /** @var ?bool */
+    /**
+     * This is used to trigger `InvalidScalarArgument` in situations where we know PHP
+     * will try to coerce one scalar type to another.
+     *
+     * @var ?bool
+     */
     public $scalar_type_match_found;
 
     /** @var ?bool */