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.

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

magento/magento2#22317: CodeSniffer should not mark correctly aligned DocBlock elements as code style violation. #22321

Merged
merged 2 commits into from
Apr 20, 2019
Merged

magento/magento2#22317: CodeSniffer should not mark correctly aligned DocBlock elements as code style violation. #22321

merged 2 commits into from
Apr 20, 2019

Conversation

p-bystritsky
Copy link
Contributor

Description (*)

Fixed Issues (if relevant)

  1. CodeSniffer should not mark correctly aligned DocBlock elements as code style violation. #22317: CodeSniffer should not mark correctly aligned DocBlock elements as code style violation.

Manual testing scenarios (*)

  1. Edit any Magento 2 class - align method params like shown here
  2. Run static tests.

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)

@m2-assistant
Copy link

m2-assistant bot commented Apr 13, 2019

Hi @p-bystritsky. 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 2.3-develop instance - deploy vanilla Magento instance

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

@p-bystritsky p-bystritsky self-assigned this Apr 13, 2019
@orlangur orlangur self-assigned this Apr 14, 2019
orlangur
orlangur reviewed Apr 14, 2019
View reviewed changes
dev/tests/static/framework/Magento/Sniffs/Annotation/MethodArgumentsSniff.php
* @param File $phpcsFile
* @param array $paramPointers
*
* @see https://devdocs.magento.com/guides/v2.3/coding-standards/docblock-standard-general.html#format-consistency
Copy link
Contributor

Choose a reason for hiding this comment

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

Omg, didn't even know we have such a dumb rule O.o

@orlangur
Copy link
Contributor

@p-bystritsky did you align such changes with @lenaorobei or @paliarush? I believe there should be some plan elaborated in regards to annotation sniffs as current ones are pretty lame, probably there is no need to try improve them sporadically.

@lenaorobei
Copy link
Contributor

Hi @p-bystritsky! The idea is to implement proper DocBlock checking sniffs and remove Annotations sniffs from Magento at all. Here are related tasks: magento/magento-coding-standard#58 and magento/magento-coding-standard#54

I did not merge those Annotations sniffs to the consolidated Coding Standard, because they produce false-positive findings.

@sivaschenko
Copy link
Member

@lenaorobei should we merge this pull request to improve the existing sniffs until the DocBlock checking is in progress?

@lenaorobei
Copy link
Contributor

@sivaschenko I don't see any reasons to not to merge, since it improves developer experience.

@ghost ghost assigned sivaschenko Apr 17, 2019
@magento-engcom-team
Copy link
Contributor

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

@nmalevanec nmalevanec self-assigned this Apr 17, 2019
@ghost ghost removed the Progress: accept label Apr 20, 2019
@magento-engcom-team magento-engcom-team mentioned this pull request Apr 20, 2019
Closed
@m2-assistant
Copy link

m2-assistant bot commented Apr 20, 2019

Hi @p-bystritsky, 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.

@magento-engcom-team magento-engcom-team merged commit 92d0f93 into magento:2.3-develop Apr 20, 2019
magento-engcom-team pushed a commit that referenced this pull request Apr 20, 2019
@sidolov
ENGCOM-4774: #22317: CodeSniffer should not mark correctly aligned Do…
604c78f 
…cBlock elements as code style violation. #22321
@magento-engcom-team magento-engcom-team added this to the Release: 2.3.2 milestone Apr 20, 2019
@p-bystritsky p-bystritsky mentioned this pull request Apr 21, 2019
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@orlangur orlangur orlangur left review comments

@sivaschenko sivaschenko sivaschenko approved these changes

Assignees

@orlangur orlangur

@sivaschenko sivaschenko

@p-bystritsky p-bystritsky

Labels
Award: bug fix Event: cdkyiv2019 Progress: needs update Release Line: 2.3
Projects
None yet
Milestone
Release: 2.3.2
Development

Successfully merging this pull request may close these issues.
6 participants
@p-bystritsky @orlangur @lenaorobei @sivaschenko @magento-engcom-team @nmalevanec