Problem/Motivation

Drupal.Commenting.VariableComment.MissingVar is not yet enabled and there are too many changes for a single issue. This is to fix any that have a default value.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Issue fork drupal-3467405

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:

Comments

quietone created an issue. See original summary.

quietone’s picture

Status: Active » Needs review
smustgrave’s picture

Status: Needs review » Reviewed & tested by the community

Seems straight forward. Was curious where the subtractions came from and see

core/modules/views/src/Plugin/views/filter/FilterPluginBase.php where the @var value was above the description. So that seems fine

Rest LGTM

catch’s picture

Status: Reviewed & tested by the community » Needs work

phpcs isn't happy locally:

FILE: ...ests/Drupal/FunctionalTests/Installer/InstallerConfigDirectoryTestBase.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
--------------------------------------------------------------------------------
 21 | ERROR | [x] Expected "string|null|bool" but found "string|NULL|bool" for
    |       |     @var tag in member variable comment
 28 | ERROR | [ ] The @var tag must be the first tag in a member variable
    |       |     comment

The @var tag must be the first tag in a member variable
| | comment

This one is because of the @todo above I think.

quietone’s picture

Status: Needs work » Needs review

I removed the @todo because the missing summary line will be discovered when enabling "Drupal.Commenting.VariableComment.Missing" as part of #2909364: [meta] Fix 'Drupal.Commenting.VariableComment' coding standard. And then change NULL to null.

mstrelan’s picture

Title: Missing @var annotation for params that provide default values » Missing @var annotation for properties that provide default values

Re-titling as this appears to be addressing properties rather than params.

smustgrave’s picture

Status: Needs review » Reviewed & tested by the community

Feedback appears to be addressed

catch’s picture

Status: Reviewed & tested by the community » Needs work

Needs a rebase.

quietone’s picture

Status: Needs work » Needs review

Rebase with one conflict in \Drupal\FunctionalTests\Update\UpdatePathTestBase

  • catch committed 6a3a4663 on 10.4.x
    Issue #3467405 by quietone, smustgrave: Missing @var annotation for...

  • catch committed b856b4bc on 11.0.x
    Issue #3467405 by quietone, smustgrave: Missing @var annotation for...

  • catch committed a7180bf1 on 11.x
    Issue #3467405 by quietone, smustgrave: Missing @var annotation for...
catch’s picture

Version: 11.x-dev » 10.4.x-dev
Status: Needs review » Fixed

Committed/pushed to 11.x and cherry-picked to 11.0.x and 10.4.x. Doesn't cherry-pick cleanly to 10.3.x but I think that's OK.

Status: Fixed » Closed (fixed)

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