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.

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

[PHPDoc] Removed @internal param from IOConfigurationPass::processHandlers #222

Merged
merged 1 commit into from
Mar 29, 2023

Conversation

adriendupuis
Copy link
Contributor

Question Answer
JIRA issue IBX-4929
Type bug
Target Ibexa version v4.0
BC breaks no

IOConfigurationPass::processHandlers method is excluded of PHP API Reference because of an @internal tag. This tag doesn't seem relevant and I propose its removal.

Checklist:

  • Provided PR description.
  • Tested the solution manually.
  • Provided automated test coverage.
  • Checked that target branch is set correctly (main for features, the oldest supported for bugs).
  • Ran PHP CS Fixer for new PHP code (use $ composer fix-cs).
  • Asked for a review (ping @ibexa/engineering).

@sonarcloud
Copy link

sonarcloud bot commented Mar 27, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

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.

👍

IOConfigurationPass::processHandlers method is excluded of PHP API Reference

@adriendupuis A question: what does this mean? I'm asking, because classes like that don't undergo BC and shouldn't be documented as PHP API. Asking for a broader context here :)

@alongosz alongosz requested a review from a team March 29, 2023 09:51
@alongosz alongosz changed the title IOConfigurationPass::processHandlers: rm @internal [PHPDoc] Removed @internal param from IOConfigurationPass::processHandlers Mar 29, 2023
@alongosz alongosz merged commit a14007e into main Mar 29, 2023
@alongosz alongosz deleted the adriendupuis-patch-1 branch March 29, 2023 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants