Opened 9 years ago
Closed 9 years ago
#28885 closed task (blessed) (fixed)
Inline Docs audit for 4.0
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 4.0 | Priority: | normal |
Severity: | normal | Version: | |
Component: | General | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description
Attachments (3)
Change History (38)
#29
follow-up:
↓ 30
@
9 years ago
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()
.
Is it possible to attach another diff-file to this ticket?
#30
in reply to:
↑ 29
@
9 years ago
Replying to 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 beWalker_Comment
, but that is only the half of the truth. As long as there is no interface defined, the type should beobject
with the description of an implemented methodpaged_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 :-)
In 29139: