[wp-trac] [WordPress Trac] #41491: document needs improvements

[WordPress Trac]

#41491: document needs improvements
--------------------------+------------------------------
 Reporter:  akbarhusen    |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  General       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:                |     Focuses:
--------------------------+------------------------------

Comment (by ayeshrajans):

 Hi @akbarhusen - The patch refers to a `@global` variable that is not
 global, but only a function argument.

 The parameter type is wrong as well.
 It should be, `@param string $name` and `@param int $comment_ID`. The
 return type could be more meaningful too.

 Also, I believe others will agree too, that one ticket to handle all the
 documentation issues in this class will help others to maintain it easily,
 instead of several small ones with vague titles.

 Thanks.

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