Add better docs to TypeComparisonResult

2024-11-30 04:39:00 +01:00 · 2021-12-19 17:59:48 +00:00 · 2021-12-19 17:59:48 +00:00 · 1e115da372
commit 1e115da372
parent ae0063051a
1 changed files with 6 additions and 1 deletions
--- a/src/Psalm/Internal/Type/Comparator/TypeComparisonResult.php
+++ b/src/Psalm/Internal/Type/Comparator/TypeComparisonResult.php
@ -7,7 +7,12 @@ use Psalm\Type\Union;

 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 */