Changeset 30537 for trunk/src/wp-includes/cron.php

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.

File:

• trunk/src/wp-includes/cron.php (modified) (1 diff)

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