[wp-trac] [WordPress Trac] #30406: Inline documentation improvements in wp-includes/link-template.php

[WordPress Trac]

#30406: Inline documentation improvements in wp-includes/link-template.php
--------------------------+-------------------
 Reporter:  dustyf        |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  4.1
Component:  Permalinks    |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+-------------------
Changes (by DrewAPicture):

 * version:  4.0 =>
 * milestone:  Awaiting Review => 4.1


Comment:

 Hi Damon and Dusty, thanks for the patches!

 Just a few things to point out that I've adjusted in
 [attachment: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 :)

--
Ticket URL: <https://core.trac.wordpress.org/ticket/30406#comment:3>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform