Skip to content

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

Conversation

kolaente
Copy link
Contributor

@kolaente kolaente commented Sep 24, 2020

Description (*)

The message on the publisher interface's publish method currently has a docblock annotation of array|object. However, since this type can be anything other than array or object as long as it's defined in the communication.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 (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • All automated tests passed successfully (all builds are green)

Resolved issues:

  1. resolves [Issue] Fix docblock annotation for PublisherInterface message #30190: Fix docblock annotation for PublisherInterface message

@m2-assistant
Copy link

m2-assistant bot commented Sep 24, 2020

Hi @kolaente. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s)
    For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests

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.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 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

Copy link
Contributor

@rogyar rogyar left a 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

@kolaente
Copy link
Contributor Author

@rogyar Done!

@sidolov sidolov added Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. labels Sep 24, 2020
@sidolov
Copy link
Contributor

sidolov commented Sep 24, 2020

@magento create issue

rogyar
rogyar previously approved these changes Sep 28, 2020
@rogyar rogyar added Cleanup Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests labels Sep 28, 2020
@magento-engcom-team
Copy link
Contributor

Hi @rogyar, thank you for the review.
ENGCOM-8277 has been created to process this Pull Request

@engcom-Alfa engcom-Alfa self-assigned this Sep 28, 2020
@engcom-Alfa
Copy link
Contributor

QA not applicable

@engcom-Foxtrot
Copy link
Contributor

@magento run all tests

@sidolov
Copy link
Contributor

sidolov commented Sep 28, 2020

Static tests are failed.

@engcom-Foxtrot
Copy link
Contributor

@kolaente param type should be specified. Please use "mixed".

@ghost ghost dismissed rogyar’s stale review September 29, 2020 11:35

Pull Request state was updated. Re-review required.

@kolaente
Copy link
Contributor Author

@engcom-Foxtrot @sidolov Should be fixed now.

@engcom-Foxtrot
Copy link
Contributor

@magento run all tests

@engcom-Foxtrot
Copy link
Contributor

@sidolov fixed.

@m2-assistant
Copy link

m2-assistant bot commented Oct 2, 2020

Hi @kolaente, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Cleanup Component: MessageQueue Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Progress: accept Release Line: 2.4 Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[Issue] Fix docblock annotation for PublisherInterface message
6 participants