[wp-trac] [WordPress Trac] #39527: Remove @param tags in DocBlocks for actions without parameters

WordPress Trac noreply at wordpress.org
Mon Jan 9 13:42:18 UTC 2017


#39527: Remove @param tags in DocBlocks for actions without parameters
--------------------------+------------------------------
 Reporter:  keesiemeijer  |       Owner:
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  Awaiting Review
Component:  General       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+------------------------------
Changes (by keesiemeijer):

 * keywords:   => has-patch


Comment:

 In [attachment:39527.patch] I've removed the `@global` tags as well as
 they are not really suited to describe a function parameter.

 They are is documented in the description of the actions:
 > The dynamic portion of the hook name, `$hook_suffix`, refers to the
 global hook suffix of the current page.

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


More information about the wp-trac mailing list