Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[PHPDoc] Prefixed template mentioning annotation with phpstan- #434

Merged
merged 1 commit into from
Oct 9, 2024
Merged

[PHPDoc] Prefixed template mentioning annotation with phpstan- #434

merged 1 commit into from
Oct 9, 2024

Conversation

mnocon
Copy link
Contributor

@mnocon mnocon commented Oct 9, 2024 •
edited
Loading

🎫 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

@mnocon mnocon requested a review from adriendupuis October 9, 2024 10:17
@mnocon mnocon mentioned this pull request Oct 9, 2024
Merged
@alongosz alongosz requested review from Steveb-p and a team October 9, 2024 10:20
alongosz
alongosz approved these changes Oct 9, 2024
View reviewed changes
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 SonarQubeCloud
Copy link

sonarqubecloud bot commented Oct 9, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@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
Reviewers

@tbialcz tbialcz tbialcz approved these changes

@adriendupuis adriendupuis adriendupuis approved these changes

@konradoboza konradoboza konradoboza approved these changes

@alongosz alongosz alongosz approved these changes

@adamwojs adamwojs adamwojs approved these changes

@Steveb-p Steveb-p Awaiting requested review from Steveb-p

Assignees

@mikadamczyk mikadamczyk

@alongosz alongosz

@tischsoic tischsoic

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@mnocon @adamwojs @alongosz @konradoboza @adriendupuis @tbialcz @mikadamczyk @tischsoic