Changeset 30537

Timestamp:

11/24/2014 04:57:17 AM (10 years ago)

Author:

DrewAPicture

Message:

Ensure inline code is markdown-escaped as such, and that code snippets in descriptions are properly indented.

Affects DocBlocks for the following core elements:

• Backtick-escapes a <link> tag in a parameter description for the embed_oembed_discover hook
• Inline code fixes in the summary and return description for WP_List_Table::get_table_classes()
• Removes HTML markup from the summary for WP_List_Table::display_rows_or_placeholder()
• Backtick-escapes a <tr> tag in a parameter description for WP_Users_List_Table::single_row()
• Converts non-DocBlocks into multi-line comments in WP_Dependencies::do_items()
• Removes HTML markup from the summary for the comment_form_top hook.
• Inline code and snippet fixes in the description for wp_get_schedules()

Props rarst for the initial patch.
See #30473.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-list-table.php (modified) (2 diffs)
• wp-admin/includes/class-wp-users-list-table.php (modified) (1 diff)
• wp-includes/class-wp-embed.php (modified) (1 diff)
• wp-includes/class.wp-dependencies.php (modified) (4 diffs)
• wp-includes/cron.php (modified) (1 diff)

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

@@ -914 +914 @@
 
     /**
-     * Get a list of CSS classes for the <table> tag
-     *
-     * @since 3.1.0
-     * @access protected
-     *
-     * @return array
+     * Get a list of CSS classes for the list table table tag.
+     *
+     * @since 3.1.0
+     * @access protected
+     *
+     * @return array List of CSS classes for the table tag.
      */
     protected function get_table_classes() {
@@ -959 +959 @@
 
     /**
-     * Generate the <tbody> part of the table
+     * Generate the tbody element for the list table.
      *
      * @since 3.1.0

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

@@ -332 +332 @@
      *
      * @param object $user_object The current user object.
-     * @param string $style       Optional. Style attributes added to the <tr> element.
+     * @param string $style       Optional. Style attributes added to the `<tr>` element.
      *                            Must be sanitized. Default empty.
      * @param string $role        Optional. Key for the $wp_roles array. Default empty.

trunk/src/wp-includes/class-wp-embed.php

@@ -230 +230 @@
              * @see WP_oEmbed::discover()
              *
-             * @param bool $enable Whether to enable link tag discovery. Default false.
+             * @param bool $enable Whether to enable `<link>` tag discovery. Default false.
              */
             $attr['discover'] = ( apply_filters( 'embed_oembed_discover', false ) && author_can( $post_ID, 'unfiltered_html' ) );

trunk/src/wp-includes/class.wp-dependencies.php

@@ -90 +90 @@
      */
     public function do_items( $handles = false, $group = false ) {
-        /**
+        /*
          * If nothing is passed, print the queue. If a string is passed,
          * print that item. If an array is passed, print those items.
@@ -100 +100 @@
             if ( !in_array($handle, $this->done, true) && isset($this->registered[$handle]) ) {
 
-                /**
+                /*
                  * A single item may alias a set of items, by having dependencies,
                  * but no source. Queuing the item queues the dependencies.
@@ -108 +108 @@
                  *
                  * The src property is false.
-                **/
+                 */
                 if ( ! $this->registered[$handle]->src ) {
                     $this->done[] = $handle;
@@ -114 +114 @@
                 }
 
-                /**
+                /*
                  * Attempt to process the item. If successful,
                  * add the handle to the done array.

trunk/src/wp-includes/cron.php

@@ -350 +350 @@
  *
  * The 'display' is the description. For the 'weekly' key, the 'display' would
- * be <code>__('Once Weekly')</code>.
+ * be `__( 'Once Weekly' )`.
  *
  * For your plugin, you will be passed an array. you can easily add your
  * schedule by doing the following.
- * <code>
- * // filter parameter variable name is 'array'
- *  $array['weekly'] = array(
- *      'interval' => 604800,
- *      'display' => __('Once Weekly')
- *  );
- * </code>
+ *
+ *     // Filter parameter variable name is 'array'.
+ *     $array['weekly'] = array(
+ *         'interval' => 604800,
+ *         'display'  => __( 'Once Weekly' )
+ *     );
+ *
  *
  * @since 2.1.0