#44520 closed defect (bug) (fixed)
Fix default parameters in controls.js JSDoc.
Reported by: | herregroen | Owned by: | atimmer |
---|---|---|---|
Milestone: | 5.1 | Priority: | normal |
Severity: | normal | Version: | 5.1 |
Component: | Customize | Keywords: | has-patch |
Focuses: | javascript, docs | Cc: |
Description
While JSDoc technically supports the @param {string=} optional
or @param {string=} [optional]
style of setting optional parameters.
It does unfortunately not support @param {string=default} optional
or @param {string=default} [optional]
style of default parameters.
Instead, as the JSDoc standards recommend, the following should be used:
@param {string} [optional]
or @param {string} [optional=default]
.
src/js/_enqueues/wp/customize/controls.js
still contains several notations of the incorrect style.
Attachments (1)
Change History (4)
Note: See
TracTickets for help on using
tickets.
In 43391: