Issue #3268838 by quietone, TR, smustgrave, xjm: Fix functions and test modules for Drupal.Commenting.DocComment.ShortSingleLine

(cherry picked from commit 6629a1634d)

core/lib/Drupal/Core/Render/theme.api.php

@@ -840,8 +840,7 @@ function hook_element_plugin_alter(array &$definitions) {
 }
 
 /**
- * Perform necessary alterations to the JavaScript before it is presented on
- * the page.
+ * Alters JavaScript before it is presented on the page.
  *
  * @param $javascript
  *   An array of all JavaScript being presented on the page.

core/modules/comment/tests/modules/comment_empty_title_test/comment_empty_title_test.module

@@ -2,8 +2,7 @@
 
 /**
  * @file
- * Dummy module emptying comment titles to test for appropriate and accessible
- * markup in edge case scenarios where comments have empty titles.
+ * Empties comment titles to test markup in edge case scenarios.
  */
 
 /**

core/modules/comment/tests/modules/comment_test/comment_test.module

@@ -2,8 +2,7 @@
 
 /**
  * @file
- * Dummy module implementing comment related hooks to test API interaction with
- * the Comment module.
+ * Implements comment-related hooks to test API interactions.
  */
 
 use Drupal\comment\CommentInterface;

core/modules/file/tests/file_test/file_test.module

@@ -42,8 +42,9 @@ function file_test_reset() {
 }
 
 /**
- * Get the arguments passed to invocation of a given hook since
- * file_test_reset() was last called.
+ * Gets the arguments passed to a given hook invocation.
+ *
+ * Arguments are gathered since file_test_reset() was last called.
  *
  * @param string $op
  *   One of the hook_file_* operations: 'load', 'validate', 'download',

core/modules/locale/locale.compare.inc

@@ -253,8 +253,7 @@ function locale_translation_batch_status_build($projects = [], $langcodes = [])
 }
 
 /**
- * Helper function to construct batch operations checking remote translation
- * status.
+ * Constructs batch operations for checking remote translation status.
  *
  * @param array $projects
  *   Array of project names to be processed.

core/modules/locale/locale.module

@@ -1067,8 +1067,9 @@ function _locale_strip_quotes($string) {
 }
 
 /**
- * Parses a JavaScript file, extracts strings wrapped in Drupal.t() and
- * Drupal.formatPlural() and inserts them into the database.
+ * Parses a JavaScript file, extracts translatable strings, and saves them.
+ *
+ * Strings are extracted from both Drupal.t() and Drupal.formatPlural().
  *
  * @param string $filepath
  *   File name to parse.

core/modules/migrate/tests/modules/migrate_prepare_row_test/migrate_prepare_row_test.module

@@ -2,8 +2,7 @@
 
 /**
  * @file
- * Test module for testing the migration source plugin prepareRow() exception
- * handling.
+ * Tests the migration source plugin prepareRow() exception handling.
  */
 
 use Drupal\migrate\Plugin\MigrationInterface;

core/modules/migrate/tests/modules/migrate_skip_all_rows_test/migrate_skip_all_rows_test.module

@@ -2,8 +2,7 @@
 
 /**
  * @file
- * Test module for testing the migration source plugin prepareRow() exception
- * handling.
+ * Tests the migration source plugin prepareRow() exception.
  */
 
 use Drupal\migrate\Plugin\MigrationInterface;

core/modules/search/tests/modules/search_langcode_test/search_langcode_test.module

@@ -2,9 +2,10 @@
 
 /**
  * @file
- * Test module setting up two tests, one for checking if the entity $langcode is
- * being passed on and another one sets up the alternate verb forms for the
- * stemming test.
+ * Tests the preprocessing of search text.
+ *
+ * Preprocessing is tested when the language code is passed to the preprocess
+ * hook and also when with alternate verb forms for the stemming test.
  */
 
 /**

core/modules/system/tests/modules/update_test_description/update_test_description.install

@@ -11,9 +11,11 @@
 function update_test_description_update_8001() {
 }
 
+// @codingStandardsIgnoreStart
 /**
  * Update test with multiline description, the quick brown fox jumped over the
  * lazy dog.
  */
 function update_test_description_update_8002() {
 }
+// @codingStandardsIgnoreEnd

core/modules/taxonomy/tests/modules/taxonomy_term_display_configurable_test/taxonomy_term_display_configurable_test.module

@@ -2,8 +2,7 @@
 
 /**
  * @file
- * A module for testing making taxonomy_term base fields' displays
- * configurable.
+ * Tests configurable displays for taxonomy_term base fields.
  */
 
 use Drupal\Core\Entity\EntityTypeInterface;

core/modules/user/user.module

@@ -999,8 +999,7 @@ function user_role_revoke_permissions($rid, array $permissions = []) {
 }
 
 /**
- * Conditionally create and send a notification email when a certain
- * operation happens on the given user account.
+ * Creates and sends a notification email following a change to a user account.
  *
  * @param string $op
  *   The operation being performed on the account. Possible values:

core/modules/views/views.module

@@ -217,8 +217,7 @@ function views_theme($existing, $type, $theme, $path) {
 }
 
 /**
- * A theme preprocess function to automatically allow view-based node
- * templates if called from a view.
+ * Allows view-based node templates if called from a view.
  *
  * The 'modules/node.views.inc' file is a better place for this, but
  * we haven't got a chance to load that file before Drupal builds the
@@ -254,8 +253,7 @@ function views_theme_suggestions_node_alter(array &$suggestions, array $variable
 }
 
 /**
- * A theme preprocess function to automatically allow view-based node
- * templates if called from a view.
+ * Allows view-based comment templates if called from a view.
  */
 function views_preprocess_comment(&$variables) {
   // The view data is added to the comment in

core/modules/views_ui/admin.inc

@@ -200,9 +200,7 @@ function views_ui_nojs_submit($form, FormStateInterface $form_state) {
 }
 
 /**
- * Add a <select> dropdown for a given section, allowing the user to
- * change whether this info is stored on the default display or on
- * the current display.
+ * Adds an element to select either the default display or the current display.
  */
 function views_ui_standard_display_dropdown(&$form, FormStateInterface $form_state, $section) {
   $view = $form_state->get('view');
@@ -269,8 +267,7 @@ function views_ui_standard_display_dropdown(&$form, FormStateInterface $form_sta
 }
 
 /**
- * Create the menu path for one of our standard AJAX forms based upon known
- * information about the form.
+ * Creates the menu path for a standard AJAX form given the form state.
  *
  * @return \Drupal\Core\Url
  *   The URL object pointing to the form URL.