Add missing DocBlock in `display` method of `WP_Comments_List_Table` class

[itowhid06]

Added missing DocBlock in display method of WP_Comments_List_Table class.

[noisysocks]

The method description here needs to be expanded a bit. @dinhtungdu volunteered in Slack to refresh the patch.

[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.

[itowhid06]

Replying to 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.

[dinhtungdu]

@itowhid06 Not every class that extends WP_List_Table overrides the display method. We do it in WP_Comments_List_Table because we render a number of hidden extra comments.

Though a lot of method DocBlock instances even some in class WP_List_Table needs to be added with a ..

I agree :). But let's leave it for the other ticket.

And about the @since tag, I'm not sure about the version when the method was introduced.

I will find it for you.

[dinhtungdu]

It's 3.1.0.

Actually, we did have the comment for display() before. (r17228). But it got deleted for some reason.

[dinhtungdu]

@itowhid06 Thanks for the patch, but I think we can be more precise for this case. What about this?

Display the comment table. Override the parent method to render extra comments.

[itowhid06]

@dinhtungdu , I've copied the text from display function in WP_Plugin_Install_List_Table class. If you insist then I can surely update it :)

[dinhtungdu]

Yeah, I still think the comment list table acts differently from other list tables, so we're better to be precise here. Please update it. Thank you so much! :)

PS: It took me 10 minutes to find out why we need extra hidden comments (They are used to append to the table when you delete or mark a comment as spam.). I think we can save other people many 10 minutes :D.

[itowhid06]

@dinhtungdu , updated according to your suggestion :)

[dinhtungdu]

Thank you for your work :)

[SergeyBiryukov]

In 46336:

Docs: Add documentation for WP_Comments_List_Table::display().

Props itowhid06, dinhtungdu.
Fixes #47929.