#42901 closed defect (bug) (fixed)
All summary tags should be removed from existing JSDoc.
Reported by: | herregroen | Owned by: | atimmer |
---|---|---|---|
Milestone: | 5.1 | Priority: | normal |
Severity: | normal | Version: | |
Component: | General | Keywords: | has-patch commit |
Focuses: | javascript, docs, coding-standards | Cc: |
Description
The WordPress javascript documentation standards were recently changed in how to deal with short and long descriptions.
This includes no longer using the @summary
tag. Instead a doc block should start with a short description and, optionally, include a longer description separated by an empty line.
Attachments (2)
Change History (8)
#1
@
7 years ago
- Focuses coding-standards added
- Keywords has-patch added
- Milestone changed from Awaiting Review to 5.0
- Version trunk deleted
#4
@
7 years ago
- Owner set to atimmer
- Resolution set to fixed
- Status changed from new to closed
In 42411:
This ticket was mentioned in Slack in #core-js by aduth. View the logs.
7 years ago
Note: See
TracTickets for help on using
tickets.
Reviewed, this is good to go in 👍🏼