Changeset 38024

Timestamp:

07/09/2016 01:59:16 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Fix minor formatting and syntax for wp-admin/* elements introduced in 4.6.

See #37318.

Location:

trunk/src/wp-admin/includes

Files:

• class-wp-posts-list-table.php (modified) (2 diffs)
• export.php (modified) (1 diff)
• media.php (modified) (1 diff)
• misc.php (modified) (1 diff)
• ms.php (modified) (1 diff)
• post.php (modified) (1 diff)

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

@@ -420 +420 @@
      * @global int $cat Currently selected category.
      *
-     * @param string $post_type The Post Type.
+     * @param string $post_type Post type slug.
      */
     protected function categories_dropdown( $post_type ) {
@@ -431 +431 @@
          *
          * @param bool   $disable   Whether to disable the categories drop-down. Default false.
-         * @param string $post_type The post type.
+         * @param string $post_type Post type slug.
          */
         if ( false !== apply_filters( 'disable_categories_dropdown', false, $post_type ) ) {

trunk/src/wp-admin/includes/export.php

@@ -257 +257 @@
 
     /**
-     * Output termmeta XML tags for a given term object.
+     * Output term meta XML tags for a given term object.
      *
      * @since 4.6.0

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

@@ -2770 +2770 @@
 
         /**
-         * Fires when attachment type can't be rendered in the edit form.
+         * Fires when an attachment type can't be rendered in the edit form.
          *
          * @since 4.6.0

trunk/src/wp-admin/includes/misc.php

@@ -921 +921 @@
 
 /**
- * Output JS that reloads the page if the user navigated to it with the Back or Forward button.
+ * Outputs JS that reloads the page if the user navigated to it with the Back or Forward button.
  *
  * Used on the Edit Post and Add New Post screens. Needed to ensure the page is not loaded from browser cache,

trunk/src/wp-admin/includes/ms.php

@@ -1036 +1036 @@
  *
  * @param $args {
- *     Optional. Array or string of Query parameters.
- *
- *     @type int     $blog_id   The site ID. Default is the current site.
- *     @type array   $links     The tabs to include with (label|url|cap) keys.
- *     @type string  $selected  The ID of the selected link.
+ *     Optional. Array or string of Query parameters. Default empty array.
+ *
+ *     @type int    $blog_id  The site ID. Default is the current site.
+ *     @type array  $links    The tabs to include with (label|url|cap) keys.
+ *     @type string $selected The ID of the selected link.
  * }
  */

trunk/src/wp-admin/includes/post.php

@@ -1437 +1437 @@
      *
      * @since 2.9.0
-     * @since 3.5.0 Added $post->ID
-     * @since 4.6.0 Added $thumbnail_id
+     * @since 3.5.0 Added the `$post_id` parameter.
+     * @since 4.6.0 Added the `$thumbnail_id` parameter.
      *
      * @param string $content      Admin post thumbnail HTML markup.