Skip to content
Snippets Groups Projects

Issue #3268833: Fix method comments in tests for Drupal.Commenting.DocComment.ShortSingleLine

Issue #3268833: Fix method comments in tests for Drupal.Commenting.DocComment.ShortSingleLine

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
49 49 }
50 50
51 51 /**
52 * Test skip non existent node.
53 *
52 54 * Tests that term associations are ignored when they belong to nodes which
53 55 * were not migrated.
  • Comment on lines +52 to 55
    Author Maintainer

    This violates several of our rules for these one-line summaries:

    • The verb should be "tests".
    • The summary should be a grammatically correct and complete predicate.
    • The summary does not describe what the method does.
    Suggested change
    Applied
    52 * Test skip non existent node.
    53 *
    54 * Tests that term associations are ignored when they belong to nodes which
    55 * were not migrated.
    52 * Tests that term relationships are ignored for un-migrated nodes.
  • changed this line in version 3 of the diff

  • Please register or sign in to reply
  • 40 40 }
    41 41
    42 42 /**
    43 * Test first sentence question.
    44 *
    43 45 * Tests an edge case where the first sentence is a question and
    44 46 * subsequent sentences are not. This edge case is documented at
    45 47 * https://www.drupal.org/node/180425.
    • Comment on lines +43 to 47
      Author Maintainer

      I looked at the link and it's just a link to the issue that introduced a fix, which is against our coding standards (because that's what git blame is for).

      Suggested change
      Applied
      43 * Test first sentence question.
      44 *
      45 * Tests an edge case where the first sentence is a question and
      46 * subsequent sentences are not. This edge case is documented at
      47 * https://www.drupal.org/node/180425.
      43 * Tests text summaries for a question followed by a sentence.
    • changed this line in version 3 of the diff

    • Please register or sign in to reply
  • 231 233 }
    232 234
    233 235 /**
    234 * Tests text_summary() returns an empty string without any error when
    235 * called with an invalid format.
    236 * Tests invalid filter format.
    237 *
    238 * Tests text_summary() returns an empty string without any error when called
    239 * with an invalid format.
    • Comment on lines -234 to +239
      Author Maintainer
      Suggested change
      Applied
      236 * Tests invalid filter format.
      237 *
      238 * Tests text_summary() returns an empty string without any error when called
      239 * with an invalid format.
      236 * Tests text summaries with an invalid filter format.
      237 *
      238 * @see text_summary()

      (And yes, text_summary() does still exist. I checked.)

    • Qiangjun Ran changed this line in version 3 of the diff

      changed this line in version 3 of the diff

    • Please register or sign in to reply
  • 114 114 }
    115 115
    116 116 /**
    117 * Tests the toolbar_modules_installed() and toolbar_modules_uninstalled() hook
    118 * implementations.
    117 * Tests toolbar_modules_installed() and toolbar_modules_uninstalled() hooks.
    • Comment on lines -117 to +117
      Author Maintainer

      This is actually not accurate... "Hook" refers only to the generic callback, e.g. hook_modules_installed(). These are definitely only hook implementations.

      I would instead go for:

      Suggested change
      Applied
      117 * Tests toolbar_modules_installed() and toolbar_modules_uninstalled() hooks.
      117 * Tests Toolbar's responses to installing and uninstalling modules.
      118 *
      119 * @see toolbar_modules_installed()
      120 * @see toolbar_modules_uninstalled()
    • Qiangjun Ran changed this line in version 3 of the diff

      changed this line in version 3 of the diff

    • Please register or sign in to reply
  • 174 173 }
    175 174
    176 175 /**
    177 * Exercises the toolbar_user_role_update() and toolbar_user_update() hook
    178 * implementations.
    176 * Tests toolbar_user_role_update() and toolbar_user_update() hooks.
  • 240 238 }
    241 239
    242 240 /**
    241 * Test non current user account updates.
    242 *
    243 243 * Tests that changes to a user account by another user clears the changed
    244 244 * account's toolbar cached, not the user's who took the action.
  • 11 11 abstract class TourTestBase extends BrowserTestBase {
    12 12
    13 13 /**
    14 * Assert function to determine if tips rendered to the page
    15 * have a corresponding page element.
    14 * Assert that tips rendered to the page have a corresponding page element.
  • Qiangjun Ran added 1 commit

    added 1 commit

    Compare with previous version

  • Qiangjun Ran added 1 commit

    added 1 commit

    • 750b1e16 - Fix @see reference should not contain any additional text

    Compare with previous version

  • quietone added 72 commits

    added 72 commits

    • 750b1e16...90596616 - 59 commits from branch project:10.1.x
    • 463a41a7 - #2
    • bd488520 - Apply 17 suggestion(s) to 15 file(s)
    • d3c788fe - Apply 1 suggestion(s) to 1 file(s)
    • 2910c623 - Apply 31 suggestion(s) to 23 file(s)
    • a5a34d8a - Remove property fixes, add @covers
    • 18934384 - remove files for removed extensions
    • 52a623b8 - Respond to two threads
    • f79e39b3 - Update JsonApiDocumentTopLevelNormalizerTest.php
    • 59d497a9 - Update LocaleImportFunctionalTest.php
    • 4486c0e5 - Update LinkAccessConstraintValidatorTest.php
    • 523714b6 - Update FilterAPITest.php
    • 0124f9a6 - Accept suggested changes from @xjm
    • 64a3a706 - Fix @see reference should not contain any additional text

    Compare with previous version

  • quietone added 2 commits

    added 2 commits

    • a2518ba4 - Updates for core/modules files
    • a20652d7 - Updates for core/profiles and core/tests files

    Compare with previous version

  • quietone
  • quietone
  • quietone added 39 commits

    added 39 commits

    • a20652d7...30a1e232 - 24 commits from branch project:10.1.x
    • 98b70d11 - #2
    • 5d775bc5 - Apply 17 suggestion(s) to 15 file(s)
    • 37f54f8a - Apply 1 suggestion(s) to 1 file(s)
    • 7063e447 - Apply 31 suggestion(s) to 23 file(s)
    • fd114f1d - Remove property fixes, add @covers
    • d9927ea0 - remove files for removed extensions
    • dffe51fe - Respond to two threads
    • 15bf3a85 - Update JsonApiDocumentTopLevelNormalizerTest.php
    • d5b71f5f - Update LocaleImportFunctionalTest.php
    • 65bda546 - Update LinkAccessConstraintValidatorTest.php
    • de9d8bf2 - Update FilterAPITest.php
    • 1895d793 - Accept suggested changes from @xjm
    • b0ab647c - Fix @see reference should not contain any additional text
    • 9e10f91b - Updates for core/modules files
    • 5bcfe29e - Updates for core/profiles and core/tests files

    Compare with previous version

  • quietone added 94 commits

    added 94 commits

    • 5bcfe29e...bb8f1aad - 79 commits from branch project:10.1.x
    • 87fab4a6 - #2
    • bd637bba - Apply 17 suggestion(s) to 15 file(s)
    • 8994959b - Apply 1 suggestion(s) to 1 file(s)
    • 818f3f7d - Apply 31 suggestion(s) to 23 file(s)
    • ceb48975 - Remove property fixes, add @covers
    • e5bc7fc6 - remove files for removed extensions
    • 74a0bae0 - Respond to two threads
    • c475894f - Update JsonApiDocumentTopLevelNormalizerTest.php
    • ad087c3a - Update LocaleImportFunctionalTest.php
    • 02153da6 - Update LinkAccessConstraintValidatorTest.php
    • 2dc4353a - Update FilterAPITest.php
    • 44816613 - Accept suggested changes from @xjm
    • e1147d47 - Fix @see reference should not contain any additional text
    • d97032c8 - Updates for core/modules files
    • 7cd3bc1c - Updates for core/profiles and core/tests files

    Compare with previous version

  • quietone added 134 commits

    added 134 commits

    Compare with previous version

  • quietone added 1 commit

    added 1 commit

    Compare with previous version

  • quietone added 42 commits

    added 42 commits

    Compare with previous version

  • quietone added 43 commits

    added 43 commits

    Compare with previous version

  • closed

  • Please register or sign in to reply
    Loading