Fix function docs (#1138)

obenland · web-flow · commit 1293380f26f4 · 2025-01-08T09:59:58.000-06:00
diff --git a/includes/functions.php b/includes/functions.php
@@ -620,7 +620,7 @@ function is_json( $data ) {
 }
 
 /**
- * Check whther a blog is public based on the `blog_public` option.
+ * Check whether a blog is public based on the `blog_public` option.
  *
  * @return bool True if public, false if not
  */
@@ -1071,7 +1071,7 @@ function ( $enclosure ) {
  *
  * @param int|\WP_Comment $comment Comment ID or comment object.
  *
- * @return \WP_Comment[] Array of ancestor comments or empty array if there are none.
+ * @return int[] Array of ancestor IDs.
  */
 function get_comment_ancestors( $comment ) {
 	$comment = \get_comment( $comment );

Original file line number	Diff line number	Diff line change
`@@ -620,7 +620,7 @@ function is_json( $data ) {`
`620`	`620`	`}`
`621`	`621`
`622`	`622`	`/**`
`623`		- * Check whther a blog is public based on the `blog_public` option.
	`623`	+ * Check whether a blog is public based on the `blog_public` option.
`624`	`624`	`*`
`625`	`625`	`* @return bool True if public, false if not`
`626`	`626`	`*/`
`@@ -1071,7 +1071,7 @@ function ( $enclosure ) {`
`1071`	`1071`	`*`
`1072`	`1072`	`* @param int\|\WP_Comment $comment Comment ID or comment object.`
`1073`	`1073`	`*`
`1074`		`- * @return \WP_Comment[] Array of ancestor comments or empty array if there are none.`
	`1074`	`+ * @return int[] Array of ancestor IDs.`
`1075`	`1075`	`*/`
`1076`	`1076`	`function get_comment_ancestors( $comment ) {`
`1077`	`1077`	`$comment = \get_comment( $comment );`