WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#28679 closed defect (bug) (fixed)

Document default arguments for WP_List_Table

Reported by: DrewAPicture Owned by: mikejolley
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 DrewAPicture)

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)

wp_list_table_docs.28679.diff (8.1 KB) - added by mikejolley 6 years ago.
Docs for WP_List_Table args, and @see for child classes
28679.diff (8.4 KB) - added by DrewAPicture 6 years ago.
hash notation

Download all attachments as: .zip

Change History (8)

#1 @DrewAPicture
6 years ago

  • Description modified (diff)

@mikejolley
6 years ago

Docs for WP_List_Table args, and @see for child classes

#2 @mikejolley
6 years ago

  • Keywords has-patch added; needs-patch removed

I've submitted some documentation for this, and added @see to all child constructors.

#3 @DrewAPicture
6 years ago

  • Owner set to mikejolley
  • Status changed from new to assigned

@DrewAPicture
6 years ago

hash notation

#4 @DrewAPicture
6 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.

#5 @DrewAPicture
6 years ago

  • Resolution set to fixed
  • Status changed from assigned to closed

In 29459:

Document default arguments for the WP_List_Table class. Also add referenced docblocks to extending class constructors.

Props mikejolley for the initial patch.
Fixes #28679. See #28298.

#6 @DrewAPicture
6 years ago

In 29460:

Add @access tags to constructor docblocks in list table classes.

See #28679. See [29459].

Note: See TracTickets for help on using tickets.