[wp-trac] [WordPress Trac] #28679: Document default arguments for WP_List_Table

[WordPress Trac]

#28679: Document default arguments for WP_List_Table
----------------------------------------+------------------------------
 Reporter:  DrewAPicture                |       Owner:
     Type:  defect (bug)                |      Status:  new
 Priority:  normal                      |   Milestone:  Awaiting Review
Component:  Posts, Post Types           |     Version:
 Severity:  normal                      |  Resolution:
 Keywords:  needs-patch good-first-bug  |     Focuses:  docs
----------------------------------------+------------------------------
Description changed by DrewAPicture:

Old description:

> The default arguments for `WP_Comments_List_Table` should be documented.
>
> We'd want to document `$args` on the constructor.
>
> Current Reference:
> http://developer.wordpress.org/reference/classes/WP_List_Table/
>
> Contributors looking for a good starting place should take a look at the
> [http://make.wordpress.org/core/handbook/inline-documentation-standards
> /php-documentation-standards/#1-functions-and-class-methods syntax for
> documenting function arguments].

New description:

 The default arguments for `WP_Comments_List_Table` should be documented.

 We'd want to document `$args` on the constructor.

 Current Reference:
 http://developer.wordpress.org/reference/classes/WP_List_Table/

 Contributors looking for a good starting place should take a look at the
 [http://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#1-functions-and-class-methods syntax for
 documenting function arguments].

 Additionally, we'd want to add an `@see` note for `$args` in each of the
 classes extending `WP_List_Table` down the line. See the phpDoc for
 `wp_remote_get()` for an example of how this is done.

--

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