WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

#37365 closed defect (bug) (fixed)

Document src/wp-admin/js/postbox.js

Reported by: atimmer Owned by: SergeyBiryukov
Milestone: 4.7 Priority: normal
Severity: normal Version:
Component: Administration Keywords: has-patch
Focuses: docs, javascript Cc:
PR Number:

Description

Documented src/wp-admin/js/postbox.js

Attachments (4)

document-postbox.patch (7.7 KB) - added by atimmer 3 years ago.
document-postbox.2.patch (19.9 KB) - added by atimmer 3 years ago.
document-postbox-add-returns.patch (23.2 KB) - added by atimmer 3 years ago.
document-postbox.diff (9.0 KB) - added by atimmer 3 years ago.

Download all attachments as: .zip

Change History (16)

#1 @atimmer
3 years ago

When committing this, please also give props andizer, we have pair-programmed on this.

This ticket was mentioned in Slack in #core by omar. View the logs.


3 years ago

#3 follow-up: @DrewAPicture
3 years ago

  • Keywords has-patch added
  • Type changed from enhancement to defect (bug)

Hi, thanks for the patch. Please ensure this and any future JSDocs patches follow the JavaScript Documentation Standards in terms of line wrapping, short descriptions as single sentences, third-person singular verbs, etc.

Tickets to add missing docs should also be created as defects rather than enhancements. Missing docs are a bug :-)

#4 in reply to: ↑ 3 @joostdevalk
3 years ago

Replying to DrewAPicture:

Tickets to add missing docs should also be created as defects rather than enhancements. Missing docs are a bug :-)

I felt the need to "like" this :-)

#5 @atimmer
3 years ago

document-postbox.2.patch is a revised patch following the JavaScript Documentation Standards.

#6 @ocean90
3 years ago

  • Version trunk deleted

#8 @atimmer
3 years ago

document-postbox.diff is a new patch that adds @returns to all functions.

Last edited 3 years ago by atimmer (previous) (diff)

#9 @DrewAPicture
3 years ago

  • Focuses javascript added

This ticket was mentioned in Slack in #docs by drew. View the logs.


3 years ago

#11 @SergeyBiryukov
3 years ago

  • Milestone changed from Awaiting Review to 4.7

#12 @SergeyBiryukov
3 years ago

  • Owner set to SergeyBiryukov
  • Resolution set to fixed
  • Status changed from new to closed

In 38643:

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

Props atimmer, andizer.
Fixes #37365.

Note: See TracTickets for help on using tickets.