See #2909372-14: [PP-1] Fix 'Drupal.Commenting.VariableComment.MissingVar' coding standard for the reason why this child issue was created and #2909364: [meta] Fix 'Drupal.Commenting.VariableComment' coding standard for general instructions about working on Drupal.Commenting.VariableComment coding standard errors.

CommentFileSizeAuthor
#2 issue-2924780-2.patch17.17 KBzaporylie
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

zaporylie created an issue. See original summary.

zaporylie’s picture

Status: Active » Needs review
FileSize
17.17 KB

This patch extracts from #2909372-12: [PP-1] Fix 'Drupal.Commenting.VariableComment.MissingVar' coding standard missing @var annotations for scalars that provide default value.

martin107’s picture

Status: Needs review » Reviewed & tested by the community

@zaporylie

Thanks for putting all the work into fixing this and other issues

zaporylie++

The patch still applies.

After a visual inspection of the patch ....Yep all these changes look good to me.

  • xjm committed 752fd5a on 8.5.x
    Issue #2924780 by zaporylie: Missing @var annotation for scalars that...
xjm’s picture

Version: 8.5.x-dev » 8.4.x-dev
Status: Reviewed & tested by the community » Fixed

Checked those over; it's easy to see that the correct data type is given in each case and that they're unlikely to allow a different data type (or NULL since they're being initialized to other things).

+++ b/core/modules/simpletest/tests/src/Functional/OtherInstallationProfileTestsTest.php
@@ -28,6 +28,8 @@ class OtherInstallationProfileTestsTest extends BrowserTestBase {
    * The Standard profile contains \Drupal\standard\Tests\StandardTest, which
    * should be found.
    *
+   * @var string
+   *
    * @see \Drupal\simpletest\Tests\InstallationProfileModuleTestsTest
    * @see \Drupal\drupal_system_listing_compatible_test\Tests\SystemListingCompatibleTest
    */

I opened the file to check this one since it was beyond the context lines:

protected $profile = 'minimal';

So that's correct too.

Committed to 8.5.x, and cherry-picked to 8.4.x as a pure docs improvement. Thanks!

  • xjm committed 42c1f99 on 8.4.x
    Issue #2924780 by zaporylie: Missing @var annotation for scalars that...

Status: Fixed » Closed (fixed)

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