Problem/Motivation

#3477614: Ignore VariableComment.Missing as needed was added to allow the sniff to be enabled but they are actually false positives.

Steps to reproduce

N/A

Proposed resolution

Search core for phpcs ignore lines that include Drupal.Commenting.VariableComment.Missing and remove Drupal.Commenting.VariableComment.Missing where possible.

Remaining tasks

Wait for #3477601: False positives with Drupal.Commenting.VariableComment.Missing to be complete
Revert #3477614: Ignore VariableComment.Missing as needed and others
Review

User interface changes

N/A

Introduced terminology

N/A

API changes

N/A

Data model changes

N/A

Release notes snippet

N/A

Issue fork drupal-3478812

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

smustgrave created an issue. See original summary.

quietone’s picture

quietone commented
Issue summary: View changes
Status: Active » Postponed
Issue tags: +Coding standards
quietone’s picture

quietone commented
Title: Revert Ignore VariableComment.Missing from 3477614 » Remove phpcs:ignore VariableComment.Missing
Issue summary: View changes

There are more instances being added to core where the ignore is needed, updating issue summary.

quietone opened merge request !13538

quietone’s picture

quietone commented
Status: Postponed » Needs review

This leaves one instance, in \Drupal\views\Plugin\views\argument\Date for public $option_name = 'default_argument_date';. As far as I can tell that property is not used. That needs an issue.

smustgrave’s picture

smustgrave commented
Status: Needs review » Needs work

Outside \Drupal\views\Plugin\views\argument\Date mentioned in #5 appears to be 2 more instances in PagerPluginBase

quietone’s picture

quietone commented
Status: Needs work » Needs review

Those two are Drupal.Commenting.VariableComment.MissingVar not phpcs:ignore VariableComment.Missing so they are out of scope for this issue.

smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Those were the only instances I found then

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Status: Reviewed & tested by the community » Needs work

Needs rebase.

quietone’s picture

quietone commented
Status: Needs work » Reviewed & tested by the community

Simple conflict due to removed code in 11.x, #3553348: Remove unused class property \Drupal\views\Plugin\views\argument\Date::$option_name. I am restoring RTBC

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Version: 11.x-dev » 11.3.x-dev
Status: Reviewed & tested by the community » Fixed

Committed and pushed 4a9217ba03e to 11.x and 5956a411dbf to 11.3.x. Thanks!

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

  • longwave committed 5956a411 on 11.3.x 
    docs: #3478812 Remove phpcs:ignore VariableComment.Missing

By:...

  • longwave committed 4a9217ba on 11.x 
    docs: #3478812 Remove phpcs:ignore VariableComment.Missing

By:...

longwave closed merge request !13538

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.