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

[atimmer]

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

[atimmer]

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

[DrewAPicture]

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 :-)

[joostdevalk]

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 :-)

[atimmer]

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

[netweb]

What about @returns docs, currently none of the functions in document-postbox.2.patch​ document any?

See also:

• ​https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/#functions
• ​http://usejsdoc.org/tags-returns.html

[atimmer]

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

[SergeyBiryukov]

In 38643:

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

Props atimmer, andizer.
Fixes #37365.