Document wp-admin/js/editor.js

[terwdan]

Documented the wp-admin/js/editor.js file.

Please also give props to ​ireneyoast

[SergeyBiryukov]

Missing/incomplete docs are a bug, per the ​Docs handbook and comment:3:ticket:37365:

How to submit a patch:
...
The Type should be defect (bug).
...
Leave the Version blank.

[SergeyBiryukov]

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

I've only made a couple of minor adjustments:

• The ​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 38933.patch​ look good to you?

[terwdan]

@SergeyBiryukov I think we misunderstood the third-person rule for the regular comments.

Thanks for fixing the @sinces, we had some trouble to find the correct ones.

We've looked at your updates and they look good.

[SergeyBiryukov]

In 39738:

Docs: Add documentation for wp-admin/js/editor.js.

Props terwdan, ireneyoast.
Fixes #38933.

[azaozz]

In 39911:

Docs: some improvements/fixes for editor.js.

See #38933.