Skip to content

Conversation

@mnocon
Copy link
Contributor

@mnocon mnocon commented Oct 9, 2024

🎫 Issue In/a

While working on ibexa/documentation-developer#2512 we've noticed that some of the template-mentioning annotations make their way into the PHP doc.

https://ez-systems-developer-documentation--2512.com.readthedocs.build/en/2512/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Pool-Pool.html

The PHP reference does not have a clear way of showing the template annotations - they look like a missing class, so it's best to mark them as PHPStan specific and hide them from the reference.

For QA:

Not needed

Documentation:

Not needed

Copy link
Member

@alongosz alongosz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, templates are rather PHPStan thingy for now, so we should use phpstan annotations. Sometimes it also messes with PHPStorm (though that one got better in the recent year).

What's your POV @Steveb-p ?

@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 9, 2024

@adamwojs adamwojs merged commit c338dc5 into 4.6 Oct 9, 2024
22 checks passed
@adamwojs adamwojs deleted the phpstan-phpdoc branch October 9, 2024 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants