[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 truongwp):

 Hi,

 This is inline docs for a function. Please see the example here:
 https://make.wordpress.org/core/handbook/best-practices/inline-
 documentation-standards/php/#1-functions-class-methods

 `@return type Description.` or `@return type` are correct, not `@return
 type $var Description.` or `@return Description.`

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