@psalm-yield not documented

[simPod]

I have stumbled over @psalm-yield in 3rd party code. There's no mention of it in docs though I have found some traces in source code in this repo.

Edit: just found this, o'lol

psalm/tests/DocumentationTest.php

Lines 60 to 74 in fc29d26

	private const WALL_OF_SHAME = [
	'@psalm-assert-untainted',
	'@psalm-consistent-constructor',
	'@psalm-flow',
	'@psalm-generator-return',
	'@psalm-ignore-variable-method',
	'@psalm-ignore-variable-property',
	'@psalm-override-method-visibility',
	'@psalm-override-property-visibility',
	'@psalm-scope-this',
	'@psalm-seal-methods',
	'@psalm-stub-override',
	'@psalm-taint-unescape',
	'@psalm-yield',
	];

🙃

[orklah]

Is it bad that I have no idea what the majority of those does either? :D

[orklah]

If anyone use those, please help the project and add some docs :)

[weirdan]

• @yield & @generator-return are likely used by some async frameworks (AMP?).
• @scope-this is useful where the type of $this cannot be inferred (e.g. in bound closures or included templates): https://psalm.dev/r/acfb878a1e
• @consistent-constructor is documented: https://psalm.dev/docs/annotating_code/supported_annotations/#psalm-consistent-constructor
• @stub-override is broken, please don't use it

[psalm-github-bot]

I found these snippets:

https://psalm.dev/r/acfb878a1e

<?php

class C {
    /** @var int */
    private $prop = 1;
    public function do(Closure $c): void {
        $c->call($this);
    }
}

function f(): int {
    /** @psalm-scope-this C */
    return $this->prop;
};

Psalm output (using commit b8a2ba2):

No issues!