Update PHPDoc Types Docs - #14796
Open
phpstan-bot wants to merge 1 commit into
Open
Conversation
- Added `static-closure` and `static-pure-closure` to the Callables section - These are supported by TypeNodeResolver but were missing from the docs - `static-closure` is a Closure declared `static` (doesn't bind `$this`); `static-pure-closure` is additionally side-effect free
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR documents two PHPDoc types that are resolved by
TypeNodeResolverbut were not yet mentioned anywhere in the user-facing PHPDoc types reference.What was done
I compared every type resolved by
TypeNodeResolver::resolveIdentifierTypeNode()andTypeNodeResolver::resolveGenericTypeNode()(skipping internal__-prefixed names) against the types documented inwebsite/src/writing-php-code/phpdoc-types.md.All types were already documented except two closure variants:
static-closure— aClosuredeclared asstatic, so it does not bind$this.static-pure-closure— a staticClosurethat additionally has no side effects when called.Changes
Added both types to the Callables section, next to the existing
pure-Closureentry, following the existing concise style with parenthetical descriptions.