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

This addresses various files modified in changeset [54062].

See #55646.

Built from https://develop.svn.wordpress.org/trunk@54063


git-svn-id: http://core.svn.wordpress.org/trunk@53622 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2022-09-02 06:58:09 +00:00
parent 16bc8d38a6
commit ac9f6594c4
6 changed files with 14 additions and 14 deletions

View File

@ -38,7 +38,7 @@ class Custom_Background {
private $updated; private $updated;
/** /**
* Constructor - Register administration header callback. * Constructor - Registers administration header callback.
* *
* @since 3.0.0 * @since 3.0.0
* @param callable $admin_header_callback * @param callable $admin_header_callback
@ -57,7 +57,7 @@ class Custom_Background {
} }
/** /**
* Set up the hooks for the Custom Background admin page. * Sets up the hooks for the Custom Background admin page.
* *
* @since 3.0.0 * @since 3.0.0
*/ */
@ -77,7 +77,7 @@ class Custom_Background {
} }
/** /**
* Set up the enqueue for the CSS & JavaScript files. * Sets up the enqueue for the CSS & JavaScript files.
* *
* @since 3.0.0 * @since 3.0.0
*/ */
@ -106,7 +106,7 @@ class Custom_Background {
} }
/** /**
* Execute custom background modification. * Executes custom background modification.
* *
* @since 3.0.0 * @since 3.0.0
*/ */
@ -222,7 +222,7 @@ class Custom_Background {
} }
/** /**
* Display the custom background page. * Displays the custom background page.
* *
* @since 3.0.0 * @since 3.0.0
*/ */
@ -480,7 +480,7 @@ class Custom_Background {
} }
/** /**
* Handle an Image upload for the background image. * Handles an Image upload for the background image.
* *
* @since 3.0.0 * @since 3.0.0
*/ */
@ -537,7 +537,7 @@ class Custom_Background {
} }
/** /**
* 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 * Triggers when the user adds a new background image from the
* Media Manager. * Media Manager.

View File

@ -67,7 +67,7 @@ class WP_Plugin_Install_List_Table extends WP_List_Table {
} }
/** /**
* 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 * Uses the transient data from the updates API to determine the slugs of
* known installed plugins. This might be better elsewhere, perhaps even * known installed plugins. This might be better elsewhere, perhaps even
@ -321,7 +321,7 @@ class WP_Plugin_Install_List_Table extends WP_List_Table {
} }
/** /**
* 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() { public function views() {
$views = $this->get_views(); $views = $this->get_views();

View File

@ -80,7 +80,7 @@ function display_header( $body_classes = '' ) {
} // End display_header(). } // End display_header().
/** /**
* Display installer setup form. * Displays installer setup form.
* *
* @since 2.8.0 * @since 2.8.0
* *

View File

@ -187,7 +187,7 @@ else :
<p class="description"><?php _e( 'Note: Neither of these options blocks access to your site &mdash; it is up to search engines to honor your request.' ); ?></p> <p class="description"><?php _e( 'Note: Neither of these options blocks access to your site &mdash; it is up to search engines to honor your request.' ); ?></p>
<?php <?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 * By default the privacy options form displays a single checkbox to 'discourage' search
* engines from indexing the site. Hooking to this action serves a dual purpose: * engines from indexing the site. Hooking to this action serves a dual purpose:

View File

@ -8,7 +8,7 @@
*/ */
/** /**
* 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. * when data.model is passed.
* *
* @since 3.9.0 * @since 3.9.0
@ -48,7 +48,7 @@ function wp_underscore_audio_template() {
} }
/** /**
* 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. * when data.model is passed.
* *
* @since 3.9.0 * @since 3.9.0

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.1-alpha-54062'; $wp_version = '6.1-alpha-54063';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.