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

Incorrect @var reference in docBlock of a class member variable #24971

Closed
salmanazeez786 opened this issue Oct 11, 2019 · 7 comments
Closed

Incorrect @var reference in docBlock of a class member variable #24971

salmanazeez786 opened this issue Oct 11, 2019 · 7 comments
Assignees
Labels
Component: Framework/Message Fixed in 2.4.x The issue has been fixed in 2.4-develop branch Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Issue: Format is valid Gate 1 Passed. Automatic verification of issue format passed Issue: Ready for Work Gate 4. Acknowledged. Issue is added to backlog and ready for development Progress: done Reproduced on 2.3.x The issue has been reproduced on latest 2.3 release

Comments

@salmanazeez786
Copy link

salmanazeez786 commented Oct 11, 2019

There is an incorrect @var reference in the doc block of the class member variable $queueIterator in class
\Magento\Framework\MessageQueue\Topology\Config

Preconditions (*)

  1. Magento 2.3.x

Steps to reproduce (*)

  1. Check the doc block of this class member variable \Magento\Framework\MessageQueue\Topology\Config::$queueIterator in file vendor/magento/framework-message-queue/Topology/Config.php

Expected result (*)

expected

Actual result (*)

actual

@m2-assistant
Copy link

m2-assistant bot commented Oct 11, 2019

Hi @salmanazeez786. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

  • Summary of the issue
  • Information on your environment
  • Steps to reproduce
  • Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.3-develop instance - upcoming 2.3.x release

For more details, please, review the Magento Contributor Assistant documentation.

@salmanazeez786 do you confirm that you were able to reproduce the issue on vanilla Magento instance following steps to reproduce?

  • yes
  • no

@magento-engcom-team magento-engcom-team added the Issue: Format is valid Gate 1 Passed. Automatic verification of issue format passed label Oct 11, 2019
@salmanazeez786 salmanazeez786 changed the title Invalid @var reference in docBlock of a class member variable Incorrect @var reference in docBlock of a class member variable Oct 11, 2019
@shikhamis11 shikhamis11 self-assigned this Oct 11, 2019
@m2-assistant
Copy link

m2-assistant bot commented Oct 11, 2019

Hi @shikhamis11. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

  • 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

    DetailsIf the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

  • 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

  • 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

  • 4. Verify that the issue is reproducible on 2.3-develop branch

    Details- Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
    - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
    - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

  • 5. Add label Issue: Confirmed once verification is complete.

  • 6. Make sure that automatic system confirms that report has been added to the backlog.

@shikhamis11 shikhamis11 added Component: Framework/Message Reproduced on 2.3.x The issue has been reproduced on latest 2.3 release Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed labels Oct 11, 2019
@ghost ghost unassigned shikhamis11 Oct 11, 2019
@magento-engcom-team magento-engcom-team added the Issue: Ready for Work Gate 4. Acknowledged. Issue is added to backlog and ready for development label Oct 11, 2019
@magento-engcom-team
Copy link
Contributor

✅ Confirmed by @shikhamis11
Thank you for verifying the issue. Based on the provided information internal tickets MC-21708 were created

Issue Available: @shikhamis11, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

@shikhamis11
Copy link
Member

@salmanazeez786
Thank you for reporting this issue Please create Pull request for it's correction
you can check guide for contribution
https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html

@ghost
Copy link

ghost commented Oct 11, 2019

Thank you @p-bystritsky for proposing this as Good First Issue!
Community Maintainers team will review it and add to list.

@salmanazeez786
Copy link
Author

salmanazeez786 commented Oct 11, 2019

@salmanazeez786
Thank you for reporting this issue Please create Pull request for it's correction
you can check guide for contribution
https://devdocs.magento.com/guides/v2.3/contributor-guide/contributing.html

@shikhamis11

@UncleTioma has created the pull request - #24976

Do you still want me to create a new pull request ?

@magento-engcom-team magento-engcom-team added the Fixed in 2.4.x The issue has been fixed in 2.4-develop branch label Feb 21, 2020
@magento-engcom-team
Copy link
Contributor

Hi @salmanazeez786. Thank you for your report.
The issue has been fixed in #24976 by @UncleTioma in 2.4-develop branch
Related commit(s):

The fix will be available with the upcoming 2.4.0 release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Framework/Message Fixed in 2.4.x The issue has been fixed in 2.4-develop branch Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Issue: Format is valid Gate 1 Passed. Automatic verification of issue format passed Issue: Ready for Work Gate 4. Acknowledged. Issue is added to backlog and ready for development Progress: done Reproduced on 2.3.x The issue has been reproduced on latest 2.3 release
Projects
None yet
Development

No branches or pull requests

6 participants