Merge pull request #7853 from jrmajor/generator-return

Remove `@psalm-generator-return` annotation
vimeo · Apr 13, 2022 · 0d10280 · 0d10280
2 parents 916fddb + 5717516
commit 0d10280
Show file tree

Hide file tree

Showing 3 changed files with 1 addition and 16 deletions.
diff --git a/src/Psalm/DocComment.php b/src/Psalm/DocComment.php
@@ -24,7 +24,7 @@ final class DocComment
         'assert', 'assert-if-true', 'assert-if-false', 'suppress',
         'ignore-nullable-return', 'override-property-visibility',
         'override-method-visibility', 'seal-properties', 'seal-methods',
-        'generator-return', 'ignore-falsable-return', 'variadic', 'pure',
+        'ignore-falsable-return', 'variadic', 'pure',
         'ignore-variable-method', 'ignore-variable-property', 'internal',
         'taint-sink', 'taint-source', 'assert-untainted', 'scope-this',
         'mutation-free', 'external-mutation-free', 'immutable', 'readonly',

diff --git a/tests/DocumentationTest.php b/tests/DocumentationTest.php
@@ -76,7 +76,6 @@ class DocumentationTest extends TestCase
         '@psalm-assert-untainted',
         '@psalm-consistent-constructor',
         '@psalm-flow',
-        '@psalm-generator-return',
         '@psalm-ignore-variable-method',
         '@psalm-ignore-variable-property',
         '@psalm-override-method-visibility',

diff --git a/tests/GeneratorTest.php b/tests/GeneratorTest.php
@@ -53,20 +53,6 @@ function g():Generator { yield new stdClass; }
                     '$g' => 'Generator<int, stdClass, mixed, mixed>',
                 ],
             ],
-            'generatorWithReturn' => [
-                'code' => '<?php
-                    /**
-                     * @return Generator<int,int>
-                     * @psalm-generator-return string
-                     */
-                    function fooFoo(int $i): Generator {
-                        if ($i === 1) {
-                            return "bash";
-                        }
-
-                        yield 1;
-                    }',
-            ],
             'generatorSend' => [
                 'code' => '<?php
                     /** @return Generator<int, string, DateTimeInterface, void> */