[wp-trac] [WordPress Trac] #42901: All summary tags should be removed from existing JSDoc.

WordPress Trac noreply at wordpress.org
Thu Dec 14 14:28:10 UTC 2017


#42901: All summary tags should be removed from existing JSDoc.
------------------------------+-----------------------------
 Reporter:  herregroen        |      Owner:
     Type:  defect (bug)      |     Status:  new
 Priority:  normal            |  Milestone:  Awaiting Review
Component:  General           |    Version:  trunk
 Severity:  normal            |   Keywords:
  Focuses:  javascript, docs  |
------------------------------+-----------------------------
 The WordPress javascript documentation standards were recently changed in
 how to deal with short and long descriptions.

 This includes no longer using the `@summary` tag. Instead a doc block
 should start with a short description and, optionally, include a longer
 description separated by an empty line.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/42901>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list