[wp-trac] [WordPress Trac] #47929: Add missing DocBlock in `display` method of `WP_Comments_List_Table` class
WordPress Trac
noreply at wordpress.org
Thu Aug 29 08:44:53 UTC 2019
#47929: Add missing DocBlock in `display` method of `WP_Comments_List_Table` class
----------------------------+-------------------------
Reporter: itowhid06 | Owner: dinhtungdu
Type: defect (bug) | Status: reviewing
Priority: normal | Milestone: 5.3
Component: Administration | Version:
Severity: minor | Resolution:
Keywords: needs-patch | Focuses: docs
----------------------------+-------------------------
Comment (by itowhid06):
Replying to [comment:4 dinhtungdu]:
> @itowhid06 Thanks for the patch. As we discussed in the Slack, the
description should be expanded. Consider these:
>
> - Adding explanation on why we need to override the `display` method.
> - Adding `@since` tag for the docs.
>
> By the way, don't forget to add a `.` to the end of the comment.
I really don't think there is much more to add in the description except a
`.`. Though a lot of method DocBlock instances even some in class
`WP_List_Table` needs to be added with a `.`.
And about the `@since` tag, I'm not sure about the version when the method
was introduced.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/47929#comment:5>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list