[wp-trac] [WordPress Trac] #50853: Parameter $linkdata missing array sub-parameters in DocBlock for wp_insert_link()

WordPress Trac noreply at wordpress.org
Tue Oct 20 02:40:24 UTC 2020


#50853: Parameter $linkdata missing array sub-parameters in DocBlock for
wp_insert_link()
-------------------------------------+-----------------------------
 Reporter:  stevenlinx               |       Owner:  SergeyBiryukov
     Type:  defect (bug)             |      Status:  reviewing
 Priority:  low                      |   Milestone:  5.6
Component:  Administration           |     Version:
 Severity:  normal                   |  Resolution:
 Keywords:  has-patch needs-refresh  |     Focuses:  docs
-------------------------------------+-----------------------------
Changes (by peterwilsoncc):

 * keywords:  has-patch => has-patch needs-refresh
 * priority:  normal => low


Comment:

 @stevenlinx

 Thanks for the patch, to meet the WordPress documentation standards it
 will need a few adjustments:

 * Mostly white space in the `@type`, the variable names should align on
 `$` and the first character of the descriptions should align too. For
 alignment, use spaces rather than tabs.
 * Each type should be the PHP variable rather than the database type:
 `varchar`, `datetime` and `text` become `string`.
 * Optional items will need to be indicated too.

 You can read more about the [https://developer.wordpress.org/coding-
 standards/inline-documentation-standards/php/ documentation standards] in
 the handbook.

 I've labelled this needs-refresh but don't worry if you haven't got time.
 I've also reduced the priority as the link/blogroll feature has been
 deprecated for a while so this is less urgent than other issues.

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


More information about the wp-trac mailing list