[wp-trac] [WordPress Trac] #51401: Docs: Fix bracket issue in autosave JS DocBlock

WordPress Trac noreply at wordpress.org
Mon Sep 28 10:43:04 UTC 2020


#51401: Docs: Fix bracket issue in autosave JS DocBlock
------------------------------+-------------------------------
 Reporter:  dilipbheda        |       Owner:  SergeyBiryukov
     Type:  enhancement       |      Status:  reviewing
 Priority:  normal            |   Milestone:  5.6
Component:  Autosave          |     Version:  trunk
 Severity:  normal            |  Resolution:
 Keywords:  has-patch commit  |     Focuses:  javascript, docs
------------------------------+-------------------------------
Changes (by SergeyBiryukov):

 * owner:  (none) => SergeyBiryukov
 * status:  new => reviewing
 * milestone:  Awaiting Review => 5.6


Comment:

 Thanks for the patch!

 I haven't found any other instances in core where we document object
 properties like this, but the closest match appears to be the "Record
 Type" from
 [https://google.github.io/styleguide/javascriptguide.xml#JsTypes Google
 JavaScript Style Guide]:
 {{{
 {{myNum: number, myObject}}
 }}}

 So it looks like double brackets are OK, let's just correct the second
 bracket placement.

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


More information about the wp-trac mailing list