Issue #3268833 by quietone, xjm, jungle, ravi.shankar, smustgrave, daffie, Spokje, DanielVeza: Fix method comments in tests for Drupal.Commenting.DocComment.ShortSingleLine

Author: longwave

modules/block/tests/src/Unit/Plugin/migrate/process/BlockRegionTest.php

@@ -48,6 +48,8 @@ protected function transform(array $value, Row $row = NULL) {
   }
 
   /**
+   * Tests transforming a block with the same theme and an existing region.
+   *
    * If the source and destination themes are identical, the region should only
    * be passed through if it actually exists in the destination theme.
    *
@@ -58,6 +60,8 @@ public function testTransformSameThemeRegionExists() {
   }
 
   /**
+   * Tests transforming a block with the same theme and a non-existent region.
+   *
    * If the source and destination themes are identical, the region should be
    * changed to 'content' if it doesn't exist in the destination theme.
    *

modules/config_translation/tests/src/Functional/ConfigTranslationUiTest.php

@@ -648,8 +648,7 @@ public function testViewsTranslationUI() {
   }
 
   /**
-   * Tests the number of source elements for plural strings in config
-   * translation forms.
+   * Tests plural source elements in configuration translation forms.
    */
   public function testPluralConfigStringsSourceElements() {
     $this->drupalLogin($this->adminUser);

modules/content_moderation/tests/src/Kernel/ContentModerationStateTest.php

@@ -548,8 +548,7 @@ public function testNonTranslatableEntityTypeModeration() {
   }
 
   /**
-   * Tests that a non-translatable entity type without a langcode can be
-   * moderated.
+   * Tests moderation of a non-translatable entity type with no langcode.
    */
   public function testNonLangcodeEntityTypeModeration() {
     // Unset the langcode entity key for 'entity_test_rev'.

modules/dblog/tests/src/Functional/DbLogTest.php

@@ -407,8 +407,7 @@ public function verifySort($sort = 'asc', $order = 'Date') {
   }
 
   /**
-   * Tests the escaping of links in the operation row of a database log detail
-   * page.
+   * Tests link escaping in the operation row of a database log detail page.
    */
   private function verifyLinkEscaping() {
     $link = Link::fromTextAndUrl('View', Url::fromRoute('entity.node.canonical', ['node' => 1]))->toString();

modules/field/tests/src/Functional/EntityReference/EntityReferenceAdminTest.php

@@ -299,8 +299,10 @@ public function testAvailableFormatters() {
   }
 
   /**
-   * Tests field settings for an entity reference field when the field has
-   * multiple target bundles and is set to auto-create the target entity.
+   * Tests field settings for an entity reference field.
+   *
+   * The tested entity reference field has multiple target bundles and is set
+   * to auto-create the target entity.
    */
   public function testMultipleTargetBundles() {
     /** @var \Drupal\taxonomy\Entity\Vocabulary[] $vocabularies */

modules/field/tests/src/Functional/EntityReference/EntityReferenceAutoCreateTest.php

@@ -103,8 +103,7 @@ protected function setUp(): void {
   }
 
   /**
-   * Tests that the autocomplete input element appears and the creation of a new
-   * entity.
+   * Tests the autocomplete input element and entity auto-creation.
    */
   public function testAutoCreate() {
     $this->drupalGet('node/add/' . $this->referencingType);
@@ -154,6 +153,8 @@ public function testAutoCreate() {
   }
 
   /**
+   * Tests multiple target bundles.
+   *
    * Tests if an entity reference field having multiple target bundles is
    * storing the auto-created entity in the right destination.
    */

modules/field/tests/src/Functional/TranslationWebTest.php

@@ -132,6 +132,8 @@ public function testFieldFormTranslationRevisions() {
   }
 
   /**
+   * Tests translation revisions.
+   *
    * Check if the field translation attached to the entity revision identified
    * by the passed arguments were correctly stored.
    */

modules/field/tests/src/Kernel/BulkDeleteTest.php

@@ -155,6 +155,8 @@ protected function setUp(): void {
   }
 
   /**
+   * Tests deleting fields.
+   *
    * Verify that deleting a field leaves the field data items in the database
    * and that the appropriate Field API functions can operate on the deleted
    * data and field definition.
@@ -314,6 +316,8 @@ public function testPurgeWithDeletedAndActiveField() {
   }
 
   /**
+   * Tests purging fields.
+   *
    * Verify that field data items and fields are purged when a field storage is
    * deleted.
    */
@@ -373,6 +377,8 @@ public function testPurgeField() {
   }
 
   /**
+   * Tests purging field storages.
+   *
    * Verify that field storages are preserved and purged correctly as multiple
    * fields are deleted and purged.
    */

modules/field/tests/src/Kernel/EntityReference/EntityReferenceFormatterTest.php

@@ -409,7 +409,9 @@ public function testLabelFormatter() {
   }
 
   /**
-   * Sets field values and returns a render array as built by
+   * Sets field values and returns a render array.
+   *
+   * The render array structure is as built by
    * \Drupal\Core\Field\FieldItemListInterface::view().
    *
    * @param \Drupal\Core\Entity\EntityInterface[] $referenced_entities

modules/field/tests/src/Kernel/FieldImportDeleteUninstallTest.php

@@ -109,8 +109,7 @@ public function testImportDeleteUninstall() {
   }
 
   /**
-   * Tests purging already deleted field storages and fields during a config
-   * import.
+   * Tests purging previously deleted fields and storages in config import.
    */
   public function testImportAlreadyDeletedUninstall() {
     // Create a telephone field for validation.

modules/file/tests/src/Functional/FileManagedTestBase.php

@@ -29,8 +29,7 @@ protected function setUp() {
   }
 
   /**
-   * Assert that all of the specified hook_file_* hooks were called once, other
-   * values result in failure.
+   * Asserts that the specified file hooks were called only once.
    *
    * @param string[] $expected
    *   An array of strings containing with the hook name; for example, 'load',
@@ -133,8 +132,7 @@ public function assertSameFile(FileInterface $file1, FileInterface $file2) {
   }
 
   /**
-   * Create a file and save it to the files table and assert that it occurs
-   * correctly.
+   * Creates and saves a file, asserting that it was saved.
    *
    * @param string $filepath
    *   Optional string specifying the file path. If none is provided then a

modules/file/tests/src/Kernel/FileManagedUnitTestBase.php

@@ -42,8 +42,7 @@ protected function setUp() {
   }
 
   /**
-   * Assert that all of the specified hook_file_* hooks were called once, other
-   * values result in failure.
+   * Asserts that the specified file hooks were called only once.
    *
    * @param array $expected
    *   Array with string containing with the hook name, e.g. 'load', 'save',
@@ -146,8 +145,7 @@ public function assertSameFile(FileInterface $file1, FileInterface $file2) {
   }
 
   /**
-   * Create a file and save it to the files table and assert that it occurs
-   * correctly.
+   * Creates and saves a file, asserting that it was saved.
    *
    * @param string $filepath
    *   Optional string specifying the file path. If none is provided then a

modules/filter/tests/src/Kernel/FilterAPITest.php

@@ -83,9 +83,10 @@ public function testCheckMarkupFilterSubset() {
   }
 
   /**
-   * Tests the following functions for a variety of formats:
-   *   - \Drupal\filter\Entity\FilterFormatInterface::getHtmlRestrictions()
-   *   - \Drupal\filter\Entity\FilterFormatInterface::getFilterTypes()
+   * Tests that HTML restrictions and filter types are correct.
+   *
+   * @covers \Drupal\filter\Entity\FilterFormat::getHtmlRestrictions
+   * @covers \Drupal\filter\Entity\FilterFormat::getFilterTypes
    */
   public function testFilterFormatAPI() {
     // Test on filtered_html.

modules/jsonapi/tests/src/Kernel/Normalizer/JsonApiDocumentTopLevelNormalizerTest.php

@@ -420,8 +420,7 @@ public function testNormalizeException() {
   }
 
   /**
-   * Test the message and exceptions thrown when we are requesting additional
-   * field values for Label only resource.
+   * Tests the message and exceptions when requesting a Label only resource.
    */
   public function testAliasFieldRouteException() {
     $this->assertSame('uid', $this->resourceTypeRepository->getByTypeName('node--article')->getPublicName('uid'));

modules/jsonapi/tests/src/Kernel/ResourceType/ResourceTypeRepositoryTest.php

@@ -114,8 +114,7 @@ public function testCaching() {
   }
 
   /**
-   * Ensures that a naming conflict in the mapping causes an exception to be
-   * thrown.
+   * Ensures that a naming conflict in mapping causes an exception to be thrown.
    *
    * @covers ::getFields
    * @dataProvider getFieldsProvider

modules/language/tests/src/Functional/LanguageBrowserDetectionTest.php

@@ -20,8 +20,7 @@ class LanguageBrowserDetectionTest extends BrowserTestBase {
   protected $defaultTheme = 'stark';
 
   /**
-   * Tests for adding, editing and deleting mappings between browser language
-   * codes and Drupal language codes.
+   * Tests mappings between browser language codes and Drupal language codes.
    */
   public function testUIBrowserLanguageMappings() {
     // User to manage languages.

modules/link/tests/src/Unit/Plugin/Validation/Constraint/LinkAccessConstraintValidatorTest.php

@@ -16,8 +16,7 @@
 class LinkAccessConstraintValidatorTest extends UnitTestCase {
 
   /**
-   * Tests the \Drupal\link\Plugin\Validation\Constraint\LinkAccessConstraintValidator::validate()
-   * method.
+   * Tests the access validation constraint for links.
    *
    * @param \Drupal\link\LinkItemInterface $value
    *   The link item.

modules/locale/tests/src/Functional/LocaleExportTest.php

@@ -157,8 +157,7 @@ public function getPoFile() {
   }
 
   /**
-   * Helper function that returns a .po file which strings will be marked
-   * as customized.
+   * Returns a .po file that will be marked as customized.
    */
   public function getCustomPoFile() {
     return <<< EOF

modules/locale/tests/src/Functional/LocaleImportFunctionalTest.php

@@ -505,8 +505,7 @@ public function getOverwritePoFile() {
   }
 
   /**
-   * Helper function that returns a .po file which strings will be marked
-   * as customized.
+   * Returns a .po file that will be marked as customized.
    */
   public function getCustomPoFile() {
     return <<< EOF

modules/locale/tests/src/Functional/LocalePluralFormatTest.php

@@ -48,8 +48,7 @@ protected function setUp(): void {
   }
 
   /**
-   * Tests locale_get_plural() and \Drupal::translation()->formatPlural()
-   * functionality.
+   * Tests locale_get_plural() and \Drupal::translation()->formatPlural().
    */
   public function testGetPluralFormat() {
     // Import some .po files with formulas to set up the environment.

modules/locale/tests/src/Functional/LocaleTranslationUiTest.php

@@ -244,8 +244,7 @@ public function testStringTranslation() {
   }
 
   /**
-   * Adds a language and checks that the JavaScript translation files are
-   * properly created and rebuilt on deletion.
+   * Tests the rebuilding of JavaScript translation files on deletion.
    */
   public function testJavaScriptTranslation() {
     $user = $this->drupalCreateUser([

modules/locale/tests/src/Functional/LocaleUpdateBase.php

@@ -209,8 +209,7 @@ protected function setTranslationFiles() {
   }
 
   /**
-   * Setup existing translations in the database and set up the status of
-   * existing translations.
+   * Sets up existing translations and their statuses in the database.
    */
   protected function setCurrentTranslations() {
     // Add non customized translations to the database.

modules/media/tests/src/Functional/Rest/MediaResourceTestBase.php

@@ -328,8 +328,12 @@ public function testPost() {
   }
 
   /**
-   * This duplicates some of the 'file_upload' REST resource plugin test
-   * coverage, to be able to test it on a concrete use case.
+   * Tests the 'file_upload' REST resource plugin.
+   *
+   * This test duplicates some of the 'file_upload' REST resource plugin test
+   * coverage.
+   *
+   * @see \Drupal\Tests\rest\Functional\FileUploadResourceTestBase
    */
   protected function uploadFile() {
     // Enable the 'file_upload' REST resource for the current format + auth.

modules/media/tests/src/Functional/UrlResolverTest.php

@@ -58,8 +58,7 @@ public function providerEndpointMatching() {
   }
 
   /**
-   * Tests resource URL resolution when the asset URL can be matched to a
-   * provider endpoint.
+   * Tests resource URL resolution with a matched provider endpoint.
    *
    * @covers ::getProviderByUrl
    * @covers ::getResourceUrl
@@ -118,8 +117,7 @@ public function providerUrlDiscovery() {
   }
 
   /**
-   * Tests URL resolution when the resource URL must be actively discovered by
-   * scanning the asset.
+   * Tests URL resolution when the URL is discovered by scanning the asset.
    *
    * @param string $url
    *   The asset URL to resolve.

modules/media/tests/src/FunctionalJavascript/MediaEmbedFilterConfigurationUiTest.php

@@ -144,8 +144,7 @@ public function testValidationWhenEditing($filter_html_status, $filter_align_sta
   }
 
   /**
-   * Data provider for testValidationWhenAdding() and
-   * testValidationWhenEditing().
+   * Data provider for testing validation when adding and editing media embeds.
    */
   public function providerTestValidations() {
     return [

modules/media/tests/src/Traits/OEmbedTestTrait.php

@@ -39,10 +39,11 @@ protected function useFixtureProviders() {
   }
 
   /**
-   * Configures the http_client service so that all requests are carried out
-   * relative to the URL of the fixtures directory. For example, after calling
-   * this method, a request for foobar.html will actually request
-   * http://test-site/path/to/fuxtures/foobar.html.
+   * Configures the HTTP client to always use the fixtures directory.
+   *
+   * All requests are carried out relative to the URL of the fixtures directory.
+   * For example, after calling this method, a request for foobar.html will
+   * actually request http://test-site/path/to/fixtures/foobar.html.
    */
   protected function lockHttpClientToFixtures() {
     $this->writeSettings([
@@ -62,9 +63,10 @@ protected function lockHttpClientToFixtures() {
   }
 
   /**
-   * Ensures that all oEmbed provider endpoints defined in the fixture
-   * providers.json will use the media_test_oembed.resource.get route as their
-   * URL.
+   * Ensures that oEmbed provider endpoints use the test resource route.
+   *
+   * All oEmbed provider endpoints defined in the fixture providers.json will
+   * use the media_test_oembed.resource.get route as their URL.
    *
    * This requires the media_test_oembed module in order to work.
    */

modules/migrate/tests/src/Unit/MigrateSourceTest.php

@@ -421,8 +421,7 @@ public function testPrepareRowPrepareException() {
   }
 
   /**
-   * Tests that cacheCounts, skipCount, trackChanges preserve their default
-   * values.
+   * Tests that default values are preserved for several source methods.
    */
   public function testDefaultPropertiesValues() {
     $this->migrationConfiguration['id'] = 'test_migration';

modules/migrate/tests/src/Unit/process/ExplodeTest.php

@@ -89,8 +89,7 @@ public function providerExplodeWithNonStrictAndEmptySource() {
   }
 
   /**
-   * Tests that explode raises an exception when the value cannot be casted to
-   * string.
+   * Tests Explode exception handling when string-cast fails.
    */
   public function testExplodeWithNonStrictAndNonCastable() {
     $plugin = new Explode(['delimiter' => '|', 'strict' => FALSE], 'map', []);
@@ -101,8 +100,7 @@ public function testExplodeWithNonStrictAndNonCastable() {
   }
 
   /**
-   * Tests that explode with an empty string and strict check returns a
-   * non-empty array.
+   * Tests Explode return values with an empty string and strict check.
    */
   public function testExplodeWithStrictAndEmptyString() {
     $plugin = new Explode(['delimiter' => '|'], 'map', []);

modules/migrate/tests/src/Unit/process/GetTest.php

@@ -113,8 +113,9 @@ public function integerValuesDataProvider() {
   }
 
   /**
-   * Tests the Get plugin for syntax errors, e.g. "Invalid tag_line detected" by
-   * creating a prophecy of the class.
+   * Tests the Get plugin for syntax errors by creating a prophecy of the class.
+   *
+   * An example of a syntax error is "Invalid tag_line detected".
    */
   public function testPluginSyntax() {
     $this->assertNotNull($this->prophesize(Get::class));