WordPress.org

Make WordPress Core

Changeset 30284


Ignore:
Timestamp:
11/08/2014 08:55:14 PM (6 years ago)
Author:
DrewAPicture
Message:

Fix the syntax for some status-related documentation introduced in [30155].

  • Variables in DocBlocks should be backtick-escaped
  • Parameter and return types should be as specific as possible
  • @param types and variables should align with each other, but not intentionally with the @return description

See #30230.

Location:
trunk/src
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/ajax-actions.php

    r30168 r30284  
    11501150            wp_die( 1 );
    11511151
    1152         // If the post is an autodraft, save the post as a draft and then
    1153         // attempt to save the meta.
     1152        // If the post is an autodraft, save the post as a draft and then attempt to save the meta.
    11541153        if ( $post->post_status == 'auto-draft' ) {
    11551154            $save_POST = $_POST; // Backup $_POST
  • trunk/src/wp-includes/post.php

    r30246 r30284  
    10701070 *
    10711071 * @param array|string $args     Optional. Array or string of post status arguments to compare against
    1072  *                               properties of the global $wp_post_statuses objects. Default empty array.
     1072 *                               properties of the global `$wp_post_statuses objects`. Default empty array.
    10731073 * @param string       $output   Optional. The type of output to return, either 'names' or 'objects'. Default 'names'.
    10741074 * @param string       $operator Optional. The logical operation to perform. 'or' means only one element
  • trunk/src/wp-includes/revision.php

    r30155 r30284  
    7878 * @since 2.6.0
    7979 *
    80  * @param  int   $post_id The ID of the post to save as a revision.
    81  * @return mixed Null or 0 if error, new revision ID, if success.
     80 * @param  int $post_id The ID of the post to save as a revision.
     81 * @return null|int Null or 0 if error, new revision ID, if success.
    8282 */
    8383function wp_save_post_revision( $post_id ) {
     
    456456 * @since 3.6.0
    457457 *
    458  * @param  object $post The post object.
     458 * @param WP_Post $post The post object.
    459459 * @return int The number of revisions to keep.
    460460 */
Note: See TracChangeset for help on using the changeset viewer.