Make WordPress Core

Opened 9 years ago

Closed 9 years ago

Last modified 9 years ago

#30229 closed defect (bug) (fixed)

Typos in get_items_per_page docblock for $option filter

Reported by: bobbingwide's profile bobbingwide Owned by: drewapicture's profile DrewAPicture
Milestone: 4.1 Priority: normal
Severity: normal Version: 3.8
Component: Administration Keywords: has-patch
Focuses: docs Cc:

Description

The docblock in WP_List_Item::get_items_per_page() for the $options filter hook contains two minor typos:

  1. 'netework' which should be 'network'.
  2. 'edit_$post_type}' missing the '_per_page' suffix.

I also noticed a couple of other tiny opportunities to improve it.

  1. Remove 'may' from 'Possible values may include'
  2. Add 'edit_post_per_page' and 'edit_page_per_page' before the generic 'edit_${post_type}_per_page.

I also notice that some of the parameters to protected functions are missing, but the @return is documented. I haven't addressed that in the first patch.

Attachments (1)

30229.diff (919 bytes) - added by bobbingwide 9 years ago.
Docblock comment changes for WP_List_Table::get_items_per_page $option filter hook

Download all attachments as: .zip

Change History (6)

@bobbingwide
9 years ago

Docblock comment changes for WP_List_Table::get_items_per_page $option filter hook

This ticket was mentioned in Slack in #core by bobbingwide. View the logs.


9 years ago

#2 @bobbingwide
9 years ago

  • Keywords has-patch added

#3 @DrewAPicture
9 years ago

  • Milestone changed from Awaiting Review to 4.1

#4 @DrewAPicture
9 years ago

  • Owner set to DrewAPicture
  • Resolution set to fixed
  • Status changed from new to closed

In 30227:

Fix a couple of typos in the hook documentation for the $option filter in wp-admin/includes/class-wp-list-table.php.

Props bobbingwide.
Fixes #30229.

#5 in reply to: ↑ description @DrewAPicture
9 years ago

  • Version changed from trunk to 3.8

Replying to bobbingwide:

I also notice that some of the parameters to protected functions are missing, but the @return is documented. I haven't addressed that in the first patch.

Please open new tickets for other documentation issues you've spotted.

Note: See TracTickets for help on using tickets.