#28679 closed defect (bug) (fixed)
Document default arguments for WP_List_Table
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 4.0 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Posts, Post Types | Keywords: | good-first-bug has-patch |
Focuses: | docs | Cc: |
Description (last modified by )
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 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.
Attachments (2)
Change History (8)
#2
@
11 years ago
- Keywords has-patch added; needs-patch removed
I've submitted some documentation for this, and added @see to all child constructors.
#4
@
11 years ago
- Milestone changed from Awaiting Review to 4.0
Thanks for the patch Mike!
28679.diff converts the default arguments info into a hash notation.
Note: See
TracTickets for help on using
tickets.
Docs for WP_List_Table args, and @see for child classes