[wp-trac] [WordPress Trac] #48303: Docblock improvements for 5.4

WordPress Trac noreply at wordpress.org
Fri Nov 29 18:00:00 UTC 2019


#48303: Docblock improvements for 5.4
----------------------------+---------------------
 Reporter:  desrosj         |       Owner:  (none)
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  5.4
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:                  |     Focuses:  docs
----------------------------+---------------------

Comment (by SergeyBiryukov):

 In [changeset:"46800" 46800]:
 {{{
 #!CommitTicketReference repository="" revision="46800"
 Docs: Replace `@returns` tags in JS docs with `@return`.

 Per the documentation standards, `@returns` is an unsupported synonym,
 `@return` should be used instead:
 https://make.wordpress.org/core/handbook/best-practices/inline-
 documentation-standards/javascript/

 See #48303.
 }}}

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


More information about the wp-trac mailing list