Changeset 30284 for trunk/src/wp-includes/revision.php

Timestamp:

11/08/2014 08:55:14 PM (10 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.

File:

• trunk/src/wp-includes/revision.php (modified) (2 diffs)

trunk/src/wp-includes/revision.php

@@ -78 +78 @@
  * @since 2.6.0
  *
- * @param  int   $post_id The ID of the post to save as a revision.
- * @return mixed Null or 0 if error, new revision ID, if success.
+ * @param  int $post_id The ID of the post to save as a revision.
+ * @return null|int Null or 0 if error, new revision ID, if success.
  */
 function wp_save_post_revision( $post_id ) {
@@ -456 +456 @@
  * @since 3.6.0
  *
- * @param  object $post The post object.
+ * @param WP_Post $post The post object.
  * @return int The number of revisions to keep.
  */