[wp-trac] [WordPress Trac] #42795: docs: Missing @return for WP_Comment_Query::get_comment_ids()

[WordPress Trac]

#42795: docs: Missing @return for WP_Comment_Query::get_comment_ids()
----------------------------+-------------------
 Reporter:  birgire         |       Owner:
     Type:  defect (bug)    |      Status:  new
 Priority:  normal          |   Milestone:  5.0
Component:  Comments        |     Version:  4.4
 Severity:  normal          |  Resolution:
 Keywords:  good-first-bug  |     Focuses:  docs
----------------------------+-------------------
Changes (by SergeyBiryukov):

 * milestone:  Awaiting Review => 5.0


Old description:

> The inline documentation for {{{WP_Comment_Query::get_comment_ids()}}} is
> missing the {{{@return}}} description.
>
> There are two return cases:
>
> - (int) with the count query variable as true
> - (array) for the comment ids
>
> See here:
>
> https://core.trac.wordpress.org/browser/tags/4.9/src/wp-includes/class-
> wp-comment-query.php#L889
>
> We can e.g. look into {{{WP_Comment_Query::get_comment_ids()}}} for a
> similar case.
>
> Good-first-bug?
>
> References:
>
> https://core.trac.wordpress.org/browser/tags/4.9/src/wp-includes/class-
> wp-comment-query.php#L468
>
> https://core.trac.wordpress.org/browser/tags/4.9/src/wp-includes/class-
> wp-site-query.php#L318

New description:

 The inline documentation for {{{WP_Comment_Query::get_comment_ids()}}} is
 missing the {{{@return}}} description.

 There are two return cases:

 - (int) with the count query variable as true
 - (array) for the comment ids

 See here:

 https://core.trac.wordpress.org/browser/tags/4.9/src/wp-includes/class-wp-
 comment-query.php#L889

 We can e.g. look into {{{WP_Site_Query::get_site_ids()}}} for a similar
 case.

 Good-first-bug?

 References:

 https://core.trac.wordpress.org/browser/tags/4.9/src/wp-includes/class-wp-
 comment-query.php#L468

 https://core.trac.wordpress.org/browser/tags/4.9/src/wp-includes/class-wp-
 site-query.php#L318

--

--
Ticket URL: <https://core.trac.wordpress.org/ticket/42795#comment:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform