Changeset 48198

Timestamp:

06/28/2020 11:51:29 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Miscellaneous DocBlock corrections.

See #49572.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-site-health.php (modified) (2 diffs)
• wp-includes/class-wp-block-styles-registry.php (modified) (1 diff)
• wp-includes/kses.php (modified) (2 diffs)
• wp-includes/media.php (modified) (1 diff)
• wp-includes/rest-api.php (modified) (1 diff)
• wp-includes/rest-api/class-wp-rest-server.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -2155 +2155 @@
      * Returns a boolean value of `true` if a scheduled task has been missed and ends processing.
      *
-     * If the list of crons is an instance of WP_Error, return the instance instead of a boolean value.
+     * If the list of crons is an instance of WP_Error, returns the instance instead of a boolean value.
      *
      * @since 5.2.0
@@ -2181 +2181 @@
      * Returns a boolean value of `true` if a scheduled task is late and ends processing.
      *
-     * If the list of crons is an instance of WP_Error, return the instance instead of a boolean value.
+     * If the list of crons is an instance of WP_Error, returns the instance instead of a boolean value.
      *
      * @since 5.3.0

trunk/src/wp-includes/class-wp-block-styles-registry.php

@@ -35 +35 @@
      * @since 5.3.0
      *
-     * @param string $block_name       Block ty name including namespace.
+     * @param string $block_name       Block type name including namespace.
      * @param array  $style_properties Array containing the properties of the style name, label,
      *                                 style (name of the stylesheet to be enqueued),

trunk/src/wp-includes/kses.php

@@ -2147 +2147 @@
      * @since 5.0.0 Added support for `background-image`.
      * @since 5.1.0 Added support for `text-transform`.
-     * @since 5.2.0 Added support for `background-position` and `grid-template-columns`
+     * @since 5.2.0 Added support for `background-position` and `grid-template-columns`.
      * @since 5.3.0 Added support for `grid`, `flex` and `column` layout properties.
      *              Extend `background-*` support of individual properties.
@@ -2263 +2263 @@
             'direction',
             'float',
+            'list-style-type',
             'overflow',
             'vertical-align',
-            'list-style-type',
         )
     );

trunk/src/wp-includes/media.php

@@ -1724 +1724 @@
         }
 
-        // Images should have dimension attributes for the `loading` attribute
-        // to be added.
+        // Images should have dimension attributes for the `loading` attribute to be added.
         if ( false === strpos( $image, ' width=' ) || false === strpos( $image, ' height=' ) ) {
             return $image;

trunk/src/wp-includes/rest-api.php

@@ -1298 +1298 @@
 
         if ( isset( $args['minItems'] ) && count( $value ) < $args['minItems'] ) {
-            /* translators: 1: Parameter, 2: number. */
+            /* translators: 1: Parameter, 2: Number. */
             return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must contain at least %2$s items.' ), $param, number_format_i18n( $args['minItems'] ) ) );
         }
 
         if ( isset( $args['maxItems'] ) && count( $value ) > $args['maxItems'] ) {
-            /* translators: 1: Parameter, 2: number. */
+            /* translators: 1: Parameter, 2: Number. */
             return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s must contain at most %2$s items.' ), $param, number_format_i18n( $args['maxItems'] ) ) );
         }

trunk/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -606 +606 @@
 
         foreach ( $data['_links'] as $rel => $links ) {
-            // If a list of relations was specified, and the link relation is not in the list of allowed relations, don't process the link.
+            // If a list of relations was specified, and the link relation
+            // is not in the list of allowed relations, don't process the link.
             if ( is_array( $embed ) && ! in_array( $rel, $embed, true ) ) {
                 continue;