CodeSniffer should not mark correctly aligned DocBlock elements as code style violation.

[p-bystritsky]

Summary (*)

Magento\Sniffs\Annotation\MethodArgumentsSniff is marking as incorrect any aligned argument parameters, while Magento Devdocs is obviously declaring such format as valid.

Examples (*)

/**
* ...
*
* @param string $parentId
* @param string $childId
* @param int|null $position
* @return int
* @see _insertChild() for position explanation
*/

Proposed solution

[m2-assistant]

Hi @p-bystritsky. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento-engcom-team give me 2.3-develop instance - upcoming 2.3.x release

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

@p-bystritsky do you confirm that you was able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

[m2-assistant]

Hi @p-bystritsky. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento-engcom-team give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Verify that the issue is reproducible on 2.2-develop branch.
  Details

  - Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

[magento-engcom-team]

Hi @p-bystritsky. Thank you for your report.
The issue has been fixed in #22321 by @p-bystritsky in 2.3-develop branch
Related commit(s):

• bed152b45be8c1c227434e66017f2f51a845770f
• 92d0f9324b991f2fdd92692ed643f5be60211148

The fix will be available with the upcoming 2.3.2 release.