Skip to content

Clearer PHPDocs comment for AbstractBlock and Escaper #25478

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 4 commits into from
Jan 8, 2020
Merged

Clearer PHPDocs comment for AbstractBlock and Escaper #25478

merged 4 commits into from
Jan 8, 2020

Conversation

edward-simpson
Copy link
Contributor

@edward-simpson edward-simpson commented Nov 5, 2019 •
edited
Loading

Description (*)

Improvement/clarification of PHPDocs comment for escapeJsQuote as I felt the use of the word "quote" when referring to what is actually an 'apostrophe' was a bit misleading

Magento\Framework\View\Element\AbstractBlock::escapeJsQuote
Magento\Framework\Escaper::escapeJsQuote

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)

@m2-assistant
Copy link

m2-assistant bot commented Nov 5, 2019

Hi @edward-simpson. 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.

@m2-assistant
Copy link

m2-assistant bot commented Nov 5, 2019

Hi @edward-simpson, 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.

@edward-simpson edward-simpson reopened this Nov 5, 2019
@rogyar rogyar self-assigned this Nov 6, 2019
@rogyar rogyar added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Nov 6, 2019
rogyar
rogyar previously approved these changes Nov 6, 2019
View reviewed changes
@engcom-Alfa engcom-Alfa self-assigned this Nov 6, 2019
@rogyar rogyar self-requested a review November 6, 2019 08:01
@rogyar rogyar dismissed their stale review November 6, 2019 08:02

Failing static tests

@magento-engcom-team
Copy link
Contributor

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

@magento-engcom-team
Copy link
Contributor

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

@rogyar
Copy link
Contributor

rogyar commented Nov 6, 2019

Hi @edward-simpson. Please, take a look at the failing static tests. The short description for functions/methods should be in single-line format.

@engcom-Alfa
Copy link
Contributor

QA not applicable

@edward-simpson
Simplifying Escaper and AbstractBlock escapeJsQuote description and m…
9bbc8f2 
…odifying PHPDoc param to specify can be string and array of strings
@edward-simpson edward-simpson force-pushed the abstractblock-phpdocs-escapejsquote branch from 2ffb6d0 to 9bbc8f2 Compare November 6, 2019 10:11
@ghost ghost removed the Progress: needs update label Nov 6, 2019
@magento-engcom-team
Copy link
Contributor

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

@sidolov sidolov changed the base branch from 2.3-develop to 2.4-develop December 5, 2019 17:16
@okorshenko
Copy link
Contributor

@magento run Semantic Version Checker

@slavvka
Copy link
Member

slavvka commented Dec 6, 2019

The PR is being imported now

@slavvka
Copy link
Member

slavvka commented Dec 16, 2019

@magento run Semantic Version Checker

magento-engcom-team pushed a commit that referenced this pull request Jan 8, 2020
@VladimirZaets
ENGCOM-6235: Clearer PHPDocs comment for AbstractBlock and Escaper #2…
4757483 
…5478
@magento-engcom-team magento-engcom-team merged commit 43c659e into magento:2.4-develop Jan 8, 2020
@m2-assistant
Copy link

m2-assistant bot commented Jan 8, 2020

Hi @edward-simpson, 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

@rogyar rogyar rogyar approved these changes

@melnikovi melnikovi Awaiting requested review from melnikovi

Assignees

@rogyar rogyar

@VladimirZaets VladimirZaets

@slavvka slavvka

@engcom-Alfa engcom-Alfa

Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Component: Escaper Component: View Progress: accept Release Line: 2.4
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@edward-simpson @magento-engcom-team @rogyar @engcom-Alfa @okorshenko @slavvka @ihor-sviziev @VladimirZaets @sidolov