WordPress.org

Make WordPress Core


Ignore:
Timestamp:
11/24/2014 04:57:17 AM (7 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/cron.php

    r29939 r30537  
    350350 *
    351351 * The 'display' is the description. For the 'weekly' key, the 'display' would
    352  * be <code>__('Once Weekly')</code>.
     352 * be `__( 'Once Weekly' )`.
    353353 *
    354354 * For your plugin, you will be passed an array. you can easily add your
    355355 * schedule by doing the following.
    356  * <code>
    357  * // filter parameter variable name is 'array'
    358  *  $array['weekly'] = array(
    359  *      'interval' => 604800,
    360  *      'display' => __('Once Weekly')
    361  *  );
    362  * </code>
     356 *
     357 *     // Filter parameter variable name is 'array'.
     358 *     $array['weekly'] = array(
     359 *         'interval' => 604800,
     360 *         'display'  => __( 'Once Weekly' )
     361 *     );
     362 *
    363363 *
    364364 * @since 2.1.0
Note: See TracChangeset for help on using the changeset viewer.