[wp-trac] [WordPress Trac] #38371: PHP documentation for wp_list_comments parameter reverse_top_level is incorrect

[WordPress Trac]

#38371: PHP documentation for wp_list_comments parameter reverse_top_level is
incorrect
--------------------------+-----------------------------
 Reporter:  bcole808      |      Owner:
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  Comments      |    Version:  trunk
 Severity:  normal        |   Keywords:
  Focuses:  docs          |
--------------------------+-----------------------------
 The PHP docs for the parameter currently reads:


 {{{
 @type string $reverse_top_level Ordering of the listed comments. Default
 null. Accepts 'desc', 'asc'.
 }}}

 however in reading how this parameter is used, it must be set to a boolean
 value. Using the string "desc" or "asc" will cause the function to always
 show the oldest comments first, as it gets converted to a boolean value.

 Attached is a patch to update the docs to reflect actual behavior.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/38371>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform