From b84904051bc0c000675724aa28350a26cf6aa67b Mon Sep 17 00:00:00 2001
From: Drew Jaynes <info@drewapicture.com>
Date: Sat, 7 Mar 2015 07:09:28 +0000
Subject: [PATCH] Better document parameters and the return for the
 newly-introduced `wp_attachment_is()`.

Also adds a changelog entry to the DocBlock for `wp_attachment_is_image()` to denote that it serves as a wrapper for `wp_attachment_is()` as of 4.2.0.

See [31645]. See #25275.

Built from https://develop.svn.wordpress.org/trunk@31659


git-svn-id: http://core.svn.wordpress.org/trunk@31640 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-includes/post.php    | 11 ++++++-----
 wp-includes/version.php |  2 +-
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/wp-includes/post.php b/wp-includes/post.php
index 981601bd2c..4732de8b34 100644
--- a/wp-includes/post.php
+++ b/wp-includes/post.php
@@ -5071,11 +5071,11 @@ function wp_get_attachment_thumb_url( $post_id = 0 ) {
 }
 
 /**
- * Verfify the attachment as being of a specific type
+ * Verifies an attachment is of a given type.
  *
- * @param string      $type    Type: image, audio, or video.
- * @param int|WP_Post $post_id Optional. Default 0.
- * @return bool
+ * @param string      $type    Attachment type. Accepts 'image', 'audio', or 'video'.
+ * @param int|WP_Post $post_id Optional. Attachment ID. Default 0.
+ * @return bool True if one of the accepted types, false otherwise.
  */
 function wp_attachment_is( $type, $post_id = 0 ) {
 	if ( ! $post = get_post( $post_id ) ) {
@@ -5118,9 +5118,10 @@ function wp_attachment_is( $type, $post_id = 0 ) {
 }
 
 /**
- * Check if the attachment is an image.
+ * Checks if the attachment is an image.
  *
  * @since 2.1.0
+ * @since 4.2.0 Modified into wrapper for wp_attachment_is()
  *
  * @param int|WP_Post $post Optional. Attachment ID. Default 0.
  * @return bool Whether the attachment is an image.
diff --git a/wp-includes/version.php b/wp-includes/version.php
index 0df29478f1..f1ed489661 100644
--- a/wp-includes/version.php
+++ b/wp-includes/version.php
@@ -4,7 +4,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '4.2-alpha-31658';
+$wp_version = '4.2-alpha-31659';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.