Make WordPress Core

Opened 8 years ago

Closed 7 years ago

#42795 closed defect (bug) (fixed)

docs: Missing @return for WP_Comment_Query::get_comment_ids()

Reported by: birgire's profile birgire Owned by: sergeybiryukov's profile SergeyBiryukov
Milestone: 5.1 Priority: normal
Severity: normal Version: 4.4
Component: Comments Keywords: has-patch
Focuses: docs Cc:

Description (last modified by SergeyBiryukov)

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

Attachments (1)

42795.diff (525 bytes) - added by chetan200891 8 years ago.
Created patch to add @return for WP_Comment_Query::get_comment_ids()

Download all attachments as: .zip

Change History (8)

#1 @DrewAPicture
8 years ago

  • Keywords good-first-bug added

@chetan200891
8 years ago

Created patch to add @return for WP_Comment_Query::get_comment_ids()

#2 @SergeyBiryukov
8 years ago

  • Description modified (diff)
  • Milestone changed from Awaiting Review to 5.0

#3 @SergeyBiryukov
8 years ago

  • Keywords has-patch added

#4 @SergeyBiryukov
8 years ago

  • Owner set to SergeyBiryukov
  • Resolution set to fixed
  • Status changed from new to closed

In 42376:

Docs: Add missing @return entry for WP_Comment_Query::get_comment_ids().

Props chetan200891, birgire.
Fixes #42795.

#5 @johnbillion
7 years ago

  • Keywords good-first-bug removed
  • Milestone changed from 5.0 to 5.0.1
  • Resolution fixed deleted
  • Status changed from closed to reopened

#6 @pento
7 years ago

  • Milestone changed from 5.0.1 to 5.0.2

#7 @SergeyBiryukov
7 years ago

  • Milestone changed from 5.0.2 to 5.1
  • Resolution set to fixed
  • Status changed from reopened to closed
Note: See TracTickets for help on using tickets.