From 06dd6429d9a3ae00b0c7390dd4ae690aad94dd0f Mon Sep 17 00:00:00 2001 From: Matthew Brown Date: Sun, 19 Dec 2021 17:59:48 +0000 Subject: [PATCH] Add better docs to TypeComparisonResult --- .../Internal/Type/Comparator/TypeComparisonResult.php | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/Psalm/Internal/Type/Comparator/TypeComparisonResult.php b/src/Psalm/Internal/Type/Comparator/TypeComparisonResult.php index 5fbe29af824..bdfafc95626 100644 --- 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 */