Opened 10 years ago
Closed 8 years ago
#30406 closed task (blessed) (fixed)
Inline documentation improvements in wp-includes/link-template.php
Reported by: | dustyf | Owned by: | DrewAPicture |
---|---|---|---|
Milestone: | 4.6 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Permalinks | Keywords: | |
Focuses: | docs | Cc: |
Description
Functions in wp-includes/link-template.php are lacking @return statements and some that have @return lack descriptions. This includes:
- get_next_posts_page_link() - Lacks return description.
- next_posts() - Lacks @return
- get_next_posts_link() - Lacks return description.
- get_previous_posts_page_link() - Lacks @return
- previous_posts() - Lacks return description
- get_previous_posts_link - Lacks return description.
Attachments (3)
Change History (16)
#1
@
10 years ago
I was able to find a handful more docblocks that needed descriptions and one that lacked an @param for one of the parameters. The attached diff file includes the patches from colorful tones plus my additions.
#3
@
10 years ago
- Milestone changed from Awaiting Review to 4.1
- Version 4.0 deleted
Hi Damon and Dusty, thanks for the patches!
Just a few things to point out that I've adjusted in 30406.2.patch:
- Since "link" is kind of a relative term -- especially in this file -- it's better to err on the side of specificity in saying "link URL" vs "link" as the latter implies an HTML-formatted link
- "HTML formatted" should be hyphenated
- Per core style, we generally don't use the work 'specified', so in most cases that became 'given'
- Return descriptions shouldn't align with
@param
descriptions, and also can't be optional :)
#5
@
10 years ago
- Keywords has-patch removed
- Milestone changed from 4.1 to Future Release
This will likely span past our cutoff for 4.1, though the current commits on the ticket will still count for the 4.1 release cycle.
Note: See
TracTickets for help on using
tickets.
Added missing @return statements and descriptions