Skip to content

Fix phpdoc in ItemConverter.php #25100

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 2 commits into from
Oct 23, 2019
Merged

Fix phpdoc in ItemConverter.php #25100

merged 2 commits into from
Oct 23, 2019

Conversation

bradleyfrye
Copy link
Contributor

@bradleyfrye bradleyfrye commented Oct 16, 2019 •
edited
Loading

Description (*)

Method modelToDataObject in ItemConverter.php said it returns an array, but it actually returns an object of type \Magento\Quote\Model\Cart\Totals\Item. Fixing the PHPDoc for the method.

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

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)

@bradleyfrye
Fix phpdoc in ItemConverter.php
05885bb 
Method modelToDataObject in ItemConverter.php said it returns an array, but it actually returns an object of type \Magento\Quote\Model\Cart\Totals\Item.  Fixing the PHPDoc for the method.
@m2-assistant
Copy link

m2-assistant bot commented Oct 16, 2019

Hi @bradleyfrye. 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.3-develop instance - deploy vanilla Magento instance

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

Stepa4man
Stepa4man requested changes Oct 17, 2019
View reviewed changes
Copy link
Contributor

@Stepa4man Stepa4man left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @bradleyfrye
Thanks for your contribution
Please check my comments. Also please sign CLA

app/code/Magento/Quote/Model/Cart/Totals/ItemConverter.php Outdated
@@ -71,7 +71,7 @@ public function __construct(
* Converts a specified rate model to a shipping method data object.
*
* @param \Magento\Quote\Model\Quote\Item $item
* @return array
* @return \Magento\Quote\Model\Cart\Totals\Item
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe \Magento\Quote\Api\Data\TotalsItemInterface will be a better option here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point...I actually used that type in a plugin of this method! See my new commit.

@ghost ghost assigned Stepa4man Oct 17, 2019
@bradleyfrye bradleyfrye requested a review from Stepa4man October 17, 2019 18:20
@Stepa4man Stepa4man added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Oct 18, 2019
@engcom-Bravo engcom-Bravo self-assigned this Oct 18, 2019
@magento-engcom-team
Copy link
Contributor

Hi @Stepa4man, thank you for the review.
ENGCOM-6120 has been created to process this Pull Request
✳️ @Stepa4man, could you please add one of the following labels to the Pull Request?

Label Description
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests

@magento-engcom-team
Copy link
Contributor

@bradleyfrye thank you for contributing. Please accept Community Contributors team invitation here to gain extended permissions for this repository.

@engcom-Bravo
Copy link
Contributor

✔️ QA Passed

magento-engcom-team pushed a commit that referenced this pull request Oct 23, 2019
@VladimirZaets
ENGCOM-6120: Fix phpdoc in ItemConverter.php #25100
c8e691d
@magento-engcom-team magento-engcom-team merged commit c6633b5 into magento:2.3-develop Oct 23, 2019
@m2-assistant
Copy link

m2-assistant bot commented Oct 23, 2019

Hi @bradleyfrye, 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
Reviewers

@Stepa4man Stepa4man Stepa4man approved these changes

@paliarush paliarush Awaiting requested review from paliarush

Assignees

@Stepa4man Stepa4man

@engcom-Bravo engcom-Bravo

@engcom-Golf engcom-Golf

Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Cleanup Component: Quote Progress: accept Release Line: 2.3 Squashtoberfest 2019
Projects
None yet
Milestone
Release: 2.3.4
Development

Successfully merging this pull request may close these issues.
5 participants
@bradleyfrye @magento-engcom-team @engcom-Bravo @Stepa4man @engcom-Golf