WordPress.org
Get WordPress

Make WordPress Core

Opened 10 years ago

Closed 10 years ago

#36896 closed defect (bug) (fixed)

Improve docs for the return value of WP_Comment_Query::get_comments()

Reported by: ocean90 Owned by: barryceelen
Priority: normal Milestone: 4.6
Component: Comments Version:
Severity: normal Keywords: good-first-bug has-patch commit
Cc: Focuses: docs

Description

Currently: "@return int|array The list of comments." It should explain when the function returns an integer.

Attachments (2)

36690.diff​ (1.4 KB ) - added by barryceelen 10 years ago.
36896.1.diff​ (524 bytes ) - added by barryceelen 10 years ago.

Download all attachments as: .zip

Change History (8)

@barryceelen
10 years ago

#1 @barryceelen
10 years ago

  • Keywords has-patch added; needs-patch removed

Wording shamelessly copied from comment.php
https://core.trac.wordpress.org/browser/trunk/src/wp-includes/comment.php#L214.

#2 @ocean90
10 years ago

  • Keywords needs-patch added; has-patch removed

@barryceelen Looks like you uploaded the wrong patch.

#3 @barryceelen
10 years ago

Oops! yes indeed.

@barryceelen
10 years ago

#4 @barryceelen
10 years ago

  • Keywords has-patch added; needs-patch removed

#5 @ocean90
10 years ago

  • Keywords commit added
  • Milestone Future Release → 4.6
  • Owner set to barryceelen
  • Status new → assigned

Thanks @barryceelen!

#6 @boonebgorges
10 years ago

  • Resolution → fixed
  • Status assigned → closed

In 37482:

Improve @return documentation for WP_Comment_Query::get_comments().

Props barryceelen.
Fixes #36896.

Note: See TracTickets for help on using tickets.