Opened 9 years ago
Closed 8 years ago
#37365 closed defect (bug) (fixed)
Document src/wp-admin/js/postbox.js
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 4.7 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Administration | Keywords: | has-patch |
Focuses: | docs, javascript | Cc: |
Description
Documented src/wp-admin/js/postbox.js
Attachments (4)
Change History (16)
This ticket was mentioned in Slack in #core by omar. View the logs.
9 years ago
#3
follow-up:
↓ 4
@
9 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
@
9 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
@
9 years ago
document-postbox.2.patch is a revised patch following the JavaScript Documentation Standards.
#7
@
9 years ago
What about @returns
docs, currently none of the functions in document-postbox.2.patch document any?
See also:
#8
@
9 years ago
document-postbox.diff is a new patch that adds @returns
to all functions.
When committing this, please also give props andizer, we have pair-programmed on this.