[wp-trac] [WordPress Trac] #41491: WP_Comments_List_Table documentation improvements (was: Documentation needs improvements)

WordPress Trac noreply at wordpress.org
Mon Jul 31 18:03:54 UTC 2017


#41491: WP_Comments_List_Table documentation improvements
--------------------------+------------------------------
 Reporter:  akbarhusen    |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  Comments      |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |     Focuses:  docs
--------------------------+------------------------------
Changes (by swissspidy):

 * keywords:  needs-refresh => needs-patch


Old description:



New description:

 The `WP_Comments_List_Table` has lots of properties and methods that lack
 proper inline documentation.

 These should be updated according to the PHP documentation standards that
 can be found at https://make.wordpress.org/core/handbook/best-practices
 /inline-documentation-standards/php/.

--

Comment:

 In addition to that, please try to write more meaningful ticket titles
 than "Documentation needs improvement" and write at least a short
 description.

 It's hard for us to garden tickets on trac when there are dozens of
 tickets with the same title and no description.

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


More information about the wp-trac mailing list