Skip to content

[Forwardport2.2] Fix incorrect type hinting in PHPDocs #16370

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

Closed
wants to merge 1 commit into from
Closed

[Forwardport2.2] Fix incorrect type hinting in PHPDocs #16370

wants to merge 1 commit into from

Conversation

chirag-wagento
Copy link
Contributor

Original Pull Request

#15619

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 newer 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)

@magento-engcom-team magento-engcom-team added Partner: Wagento Pull Request is created by partner Wagento partners-contribution Pull Request is created by Magento Partner Component: Sales labels Jun 24, 2018
@magento-engcom-team
Copy link
Contributor

Hi @chirag-wagento. 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-engcom-team give me test instance - deploy test instance based on PR changes
  • @magento-engcom-team give me {$VERSION} instance - deploy vanilla Magento instance

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

@chirag-wagento
Copy link
Contributor Author

As per this tickets comment #16118 (comment) (comment) created new pull request.

@orlangur orlangur self-assigned this Jun 25, 2018
@orlangur orlangur changed the title [Forwordport2.2] Fix incorrect type hinting in PHPDocs [Forwardport2.2] Fix incorrect type hinting in PHPDocs Jun 25, 2018
@orlangur
Copy link
Contributor

Hi @chirag-wagento, when porting pull requests author of the original commit must be preserved: ab64a2c

Please cherry-pick this commit into your branch instead of doing a new commit from scratch and force push into the same branch.

@chirag-wagento
Copy link
Contributor Author

Hi @orlangur

Do you want cherry-pick ab64a2c in to forwordport2.2-incorrect-type-hinting branch and commit push?

In ab64a2c changed 2.1-develop. How can I cherry pick in 2.2-develop branch ?

@orlangur
Copy link
Contributor

@chirag-wagento into the same branch: chirag-wagento:incorrect-type-hinting-forwordport2.3

In ab64a2c changed 2.1-develop. How can I cherry pick in 2.2-develop branch ?

git checkout 2.2-develop
git checkout -b incorrect-type-hinting-forwordport2.3
git cherry-pick ab64a2c

@orlangur
Copy link
Contributor

Closing due to inactivity. Feel free to reach me out anytime later if you wish to continue work on this pull request and it will be reopened.

@orlangur orlangur closed this Jul 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Sales Partner: Wagento Pull Request is created by partner Wagento partners-contribution Pull Request is created by Magento Partner Progress: needs update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants