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

Update documentation for Order#getAppliedRuleIds #18573

Merged
merged 3 commits into from
Oct 22, 2018
Merged

Update documentation for Order#getAppliedRuleIds #18573

merged 3 commits into from
Oct 22, 2018

Conversation

zack6849
Copy link
Contributor

@zack6849 zack6849 commented Oct 12, 2018

Description

Update the documentation for getAppliedRuleIds, as it is not immediately clear if this is a single number in a string, or several that are comma separated.

Manual testing scenarios

  • Attempt to getAppliedRuleIds on an OrderInterface object
  • Consult the documentation, and see it contains a string
  • Scratch your head because you're not sure if it can contain multiple IDs or not, and if so how they're separated

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)

Update the documentation for getAppliedRuleIds, as it is not immediately clear if this is a single number in a string, or several that are comma separated.
@magento-engcom-team
Copy link
Contributor

Hi @zack6849. 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

Copy link
Member

@rodrigowebjump rodrigowebjump left a comment

Choose a reason for hiding this comment

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

Hi, you include an empty line before long description, but removed the line after.

Please, include the empty line after long description :-)

Refer: https://devdocs.magento.com/guides/v2.3/coding-standards/docblock-standard-general.html

Copy link
Member

@rodrigowebjump rodrigowebjump left a comment

Choose a reason for hiding this comment

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

Hi @zack6849 Thanks for your contribution

@magento-engcom-team
Copy link
Contributor

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

@okorshenko
Copy link
Contributor

merged

@magento-engcom-team
Copy link
Contributor

Hi @zack6849. Thank you for your contribution.
We will aim to release these changes as part of 2.3.1.
Please check the release notes for final confirmation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants