-
Notifications
You must be signed in to change notification settings - Fork 9.4k
Fix docblock annotation for PublisherInterface message #30180
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
Fix docblock annotation for PublisherInterface message #30180
Conversation
Hi @kolaente. Thank you for your contribution
❗ Automated tests can be triggered manually with an appropriate comment:
You can find more information about the builds here ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review. For more details, please, review the Magento Contributor Guide documentation. 🕙 You can find the schedule on the Magento Community Calendar page. 📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket. 🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel ✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @kolaente. Please, sign Adobe CLA. So we can proceed with processing the PR.
Thank you
@rogyar Done! |
@magento create issue |
Hi @rogyar, thank you for the review. |
QA not applicable |
@magento run all tests |
Static tests are failed. |
@kolaente param type should be specified. Please use "mixed". |
lib/internal/Magento/Framework/MessageQueue/PublisherInterface.php
Outdated
Show resolved
Hide resolved
Pull Request state was updated. Re-review required.
@engcom-Foxtrot @sidolov Should be fixed now. |
@magento run all tests |
@sidolov fixed. |
Hi @kolaente, thank you for your contribution! |
Description (*)
The message on the publisher interface's
publish
method currently has a docblock annotation ofarray|object
. However, since this type can be anything other than array or object as long as it's defined in thecommunication.xml
this docblock annotation creates confusion. The docblock annotation is therefore wrong. This PR fixes that.Related Pull Requests
Manual testing scenarios (*)
Since this is a doc change, I'm not sure if there's any manual testing scenarios? Please tell me if I'm wrong.
Contribution checklist (*)
Resolved issues: