Inaccurate error with different types in PHPDoc and typehint

vimeo · Jul 26, 2021 · 72d6024 · 72d6024
1 parent ffbdaa8
commit 72d6024
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockScanner.php b/src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockScanner.php
@@ -11,6 +11,7 @@
 use Psalm\Exception\TypeParseTreeException;
 use Psalm\Internal\Scanner\FileScanner;
 use Psalm\Internal\Scanner\FunctionDocblockComment;
+use Psalm\Internal\Type\Comparator\UnionTypeComparator;
 use Psalm\Internal\Type\TypeAlias;
 use Psalm\Internal\Type\TypeParser;
 use Psalm\Internal\Type\TypeTokenizer;
@@ -908,6 +909,12 @@ private static function handleReturn(
                     && !$storage->return_type->isNullable()
                     && !$storage->return_type->hasTemplate()
                     && !$storage->return_type->hasConditional()
+                    //don't add null to docblock type if it's not contained in signature type
+                    && UnionTypeComparator::isContainedBy(
+                        $codebase,
+                        $storage->return_type,
+                        $storage->signature_return_type
+                    )
                 ) {
                     $storage->return_type->addType(new Type\Atomic\TNull());
                 }