[wp-trac] [WordPress Trac] #28885: Inline Docs audit for 4.0

[WordPress Trac]

#28885: Inline Docs audit for 4.0
----------------------------+---------------------------
 Reporter:  DrewAPicture    |       Owner:  DrewAPicture
     Type:  task (blessed)  |      Status:  assigned
 Priority:  normal          |   Milestone:  4.0
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:  has-patch       |     Focuses:  docs
----------------------------+---------------------------

Comment (by DrewAPicture):

 Replying to [comment:29 dnaber-de]:
 > While you're cleaning up the inline docs, you may want to have a look at
 the wrong parameter type specified for a custom Walker in
 wp_list_comments().
 >
 >
 > {{{
 >  *     @type string 'walker'            The Walker class used to list
 comments. Default null.
 > }}}
 > `string` is wrong. A correct type definition would be `Walker_Comment`,
 but that is only the half of the truth. As long as there is no interface
 defined, the type should be `object` with the description of an
 implemented method `paged_walk()`.

 That's a good call. I could probably go for Walker_Comment|object with a
 note in the description about the object needing to implement a
 `page_walk()` method.

 >
 > Is it possible to attach another diff-file to this ticket?

 I'd actually rather you create a separate ticket on the 'docs' focus, as
 this one is specifically for functionality added in 4.0 :-)

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