#30229 closed defect (bug) (fixed)
Typos in get_items_per_page docblock for $option filter
Reported by: |
|
Owned by: |
|
---|---|---|---|
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:
- 'netework' which should be 'network'.
- 'edit_$post_type}' missing the '_per_page' suffix.
I also noticed a couple of other tiny opportunities to improve it.
- Remove 'may' from 'Possible values may include'
- 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)
Change History (6)
This ticket was mentioned in Slack in #core by bobbingwide. View the logs.
10 years ago
#4
@
10 years ago
- Owner set to DrewAPicture
- Resolution set to fixed
- Status changed from new to closed
In 30227:
#5
in reply to:
↑ description
@
10 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.
Docblock comment changes for WP_List_Table::get_items_per_page $option filter hook