[wp-trac] [WordPress Trac] #41927: Twenty Seventeen: Missing @return in comment documentation

[WordPress Trac]

#41927: Twenty Seventeen: Missing @return in comment documentation
---------------------------+------------------------------
 Reporter:  ndoublehwp     |       Owner:
     Type:  defect (bug)   |      Status:  new
 Priority:  normal         |   Milestone:  Awaiting Review
Component:  Bundled Theme  |     Version:  trunk
 Severity:  normal         |  Resolution:
 Keywords:  has-patch      |     Focuses:  docs
---------------------------+------------------------------

Comment (by xkon):

 According to the Handbook

 Quoting:

 Note that `@return` is not used for hook documentation, because action
 hooks return nothing, and `filter hooks always return their first
 parameter.`

 So yes the original documentation was fine as it was since this is a
 `filter` function.

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