Skip to content

Fix incorrect type hinting in PHPDocs #15619

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
Merged
merged 1 commit into from
May 31, 2018
Merged

Fix incorrect type hinting in PHPDocs #15619

merged 1 commit into from
May 31, 2018

Conversation

dmytro-ch
Copy link
Contributor

@dmytro-ch dmytro-ch commented May 31, 2018 •
edited by orlangur
Loading

Description

Incorrect PHPdoc causes warnings in IDE.

Changes applied:

  1. Changed the return type for setQty method to the type it actually returns.
  2. Removed the hint for never thrown LocalizedException in PHPDocs of register and setQty methods.

Fixed Issues

  1. Incorrect phpdoc should be Shipment\Item not Invoice\Item #13992: Incorrect phpdoc should be Shipment\Item not Invoice\Item

Manual testing scenarios

  1. This is not necessary, this just resolves warnings in the IDE.

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 on Travis CI are green)

@dmytro-ch dmytro-ch added Release Line: 2.1 partners-contribution Pull Request is created by Magento Partner Partner: Atwix Pull Request is created by partner Atwix labels May 31, 2018
@dmytro-ch dmytro-ch requested a review from rogyar May 31, 2018 07:00
@magento-engcom-team magento-engcom-team added this to the Release: 2.1.15 milestone May 31, 2018
@ishakhsuvarov ishakhsuvarov mentioned this pull request May 31, 2018
Closed
@magento-engcom-team magento-engcom-team merged commit ab64a2c into magento:2.1-develop May 31, 2018
magento-engcom-team pushed a commit that referenced this pull request May 31, 2018
ENGCOM-1727: Fix incorrect type hinting in PHPDocs #15619
bf2e745
@magento-engcom-team
Copy link
Contributor

Hi @dmytro-ch. Thank you for your contribution.
Changes from your Pull Request will be available with the upcoming 2.1.15 release.

This was referenced Jun 14, 2018
Closed
Closed
This was referenced Jun 24, 2018
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rogyar rogyar Awaiting requested review from rogyar

Assignees

@rogyar rogyar

Labels
Component: Sales Partner: Atwix Pull Request is created by partner Atwix partners-contribution Pull Request is created by Magento Partner Progress: accept Release Line: 2.1
Projects
None yet
Milestone
Release: 2.1.15
Development

Successfully merging this pull request may close these issues.
3 participants
@dmytro-ch @magento-engcom-team @rogyar