Changeset 54063

Timestamp:

09/02/2022 06:56:12 AM (3 years ago)

Author:

audrasjb

Message:

Docs: Use third-person singular verbs for various function descriptions, as per docblocks standards.

This addresses various files modified in changeset [54062].

See #55646.

Location:

trunk/src

Files:

• wp-admin/includes/class-custom-background.php (modified) (7 diffs)
• wp-admin/includes/class-wp-plugin-install-list-table.php (modified) (2 diffs)
• wp-admin/install.php (modified) (1 diff)
• wp-admin/options-reading.php (modified) (1 diff)
• wp-includes/media-template.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-custom-background.php

@@ -39 +39 @@
 
     /**
-     * Constructor - Register administration header callback.
+     * Constructor - Registers administration header callback.
      *
      * @since 3.0.0
@@ -58 +58 @@
 
     /**
-     * Set up the hooks for the Custom Background admin page.
+     * Sets up the hooks for the Custom Background admin page.
      *
      * @since 3.0.0
@@ -78 +78 @@
 
     /**
-     * Set up the enqueue for the CSS & JavaScript files.
+     * Sets up the enqueue for the CSS & JavaScript files.
      *
      * @since 3.0.0
@@ -107 +107 @@
 
     /**
-     * Execute custom background modification.
+     * Executes custom background modification.
      *
      * @since 3.0.0
@@ -223 +223 @@
 
     /**
-     * Display the custom background page.
+     * Displays the custom background page.
      *
      * @since 3.0.0
@@ -481 +481 @@
 
     /**
-     * Handle an Image upload for the background image.
+     * Handles an Image upload for the background image.
      *
      * @since 3.0.0
@@ -538 +538 @@
 
     /**
-     * Ajax handler for adding custom background context to an attachment.
+     * Handles Ajax request for adding custom background context to an attachment.
      *
      * Triggers when the user adds a new background image from the

trunk/src/wp-admin/includes/class-wp-plugin-install-list-table.php

@@ -68 +68 @@
 
     /**
-     * Return a list of slugs of installed plugins, if known.
+     * Returns a list of slugs of installed plugins, if known.
      *
      * Uses the transient data from the updates API to determine the slugs of
@@ -322 +322 @@
 
     /**
-     * Override parent views so we can use the filter bar display.
+     * Overrides parent views so we can use the filter bar display.
      */
     public function views() {

trunk/src/wp-admin/install.php

@@ -81 +81 @@
 
 /**
- * Display installer setup form.
+ * Displays installer setup form.
  *
  * @since 2.8.0

trunk/src/wp-admin/options-reading.php

@@ -188 +188 @@
     <?php
     /**
-     * Enable the legacy 'Site visibility' privacy options.
+     * Enables the legacy 'Site visibility' privacy options.
      *
      * By default the privacy options form displays a single checkbox to 'discourage' search

trunk/src/wp-includes/media-template.php

@@ -9 +9 @@
 
 /**
- * Output the markup for a audio tag to be used in an Underscore template
+ * Outputs the markup for a audio tag to be used in an Underscore template
  * when data.model is passed.
  *
@@ -49 +49 @@
 
 /**
- * Output the markup for a video tag to be used in an Underscore template
+ * Outputs the markup for a video tag to be used in an Underscore template
  * when data.model is passed.
  *