[wp-trac] [WordPress Trac] #38933: Document wp-admin/js/editor.js

[WordPress Trac]

#38933: Document wp-admin/js/editor.js
------------------------------+-------------------------------
 Reporter:  terwdan           |       Owner:  SergeyBiryukov
     Type:  defect (bug)      |      Status:  reviewing
 Priority:  normal            |   Milestone:  4.8
Component:  Editor            |     Version:
 Severity:  normal            |  Resolution:
 Keywords:  has-patch commit  |     Focuses:  javascript, docs
------------------------------+-------------------------------
Changes (by SergeyBiryukov):

 * keywords:   => has-patch commit
 * milestone:  Awaiting Review => 4.8


Comment:

 @terwdan: [attachment:editorjs.diff] is a great start, thank you for the
 patch!

 I've only made a couple of minor adjustments:
 * The [https://make.wordpress.org/core/handbook/best-practices/inline-
 documentation-standards/javascript/ standards] say that third-person
 singular verbs should be used for functions and closures, but I think
 regular comments that refer to the next few lines should still be "Do
 something" rather than "Does something".
 * Some `@since` entries weren't fully blamed to the original change. We
 don't generally introduce new functions in minor releases :)

 Does [attachment:38933.patch] look good to you?

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