WordPress.org

Make WordPress Core

Opened 11 months ago

Closed 10 months ago

Last modified 9 months ago

#38933 closed defect (bug) (fixed)

Document wp-admin/js/editor.js

Reported by: terwdan Owned by: SergeyBiryukov
Milestone: 4.8 Priority: normal
Severity: normal Version:
Component: Editor Keywords: has-patch commit
Focuses: javascript, docs Cc:

Description

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

Please also give props to ireneyoast

Attachments (2)

editorjs.diff (20.2 KB) - added by terwdan 11 months ago.
38933.patch (20.2 KB) - added by SergeyBiryukov 10 months ago.

Download all attachments as: .zip

Change History (9)

@terwdan
11 months ago

#1 @SergeyBiryukov
11 months ago

  • Owner set to SergeyBiryukov
  • Status changed from new to reviewing

#2 @helen
11 months ago

  • Type changed from defect (bug) to enhancement

#3 @SergeyBiryukov
11 months ago

  • Type changed from enhancement to defect (bug)
  • Version trunk deleted

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.

Last edited 11 months ago by SergeyBiryukov (previous) (diff)

#4 @SergeyBiryukov
10 months ago

  • Keywords has-patch commit added
  • Milestone changed from Awaiting Review to 4.8

@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?

#5 @terwdan
10 months ago

@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.

#6 @SergeyBiryukov
10 months ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 39738:

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

Props terwdan, ireneyoast.
Fixes #38933.

#7 @azaozz
9 months ago

In 39911:

Docs: some improvements/fixes for editor.js.

See #38933.

Note: See TracTickets for help on using tickets.