Update JSDoc #13742
Update JSDoc #13742
Conversation
oandregal
requested review from
aduth,
gziolo,
ellatrix,
jorgefilipecosta and
youknowriad
as code owners
oandregal
added
[Type] Developer Documentation
|
Is this part of a systematic check of all documentation for RichText? |
| @@ -8,7 +8,7 @@ import { normaliseFormats } from './normalise-formats'; | |||
| * Combine all Rich Text values into one. This is similar to | |||
| * `String.prototype.concat`. | |||
| * | |||
| * @param {...[object]} values An array of all values to combine. | |||
| * @param {...Object} values Objects to combine. | |||
There was a problem hiding this comment.
I thought I'd seen the removed syntax around... The one you're suggesting seems correct but it's a bit weird to me. values is an array, not an object?
There was a problem hiding this comment.
I'm working on generating documentation (markdown, html) from the JSDoc comments and this one didn't pass my tests. I didn't find this way of param type declaration in the standard.
I thought it took objects as input? As in concat( object1, object2, object3 );. That is what is implied in the tests. concat converts that input into an array, though:
export function concat( ...values ) { }
There was a problem hiding this comment.
Changes as proposed seem correct to me. If it receives variadic arguments, it should be a ... prefix on the type expected.
From your link, see under "Variable number of that type". The main difference is ES2015+ adds syntax support for the spread argument.
Related:
Update JSDoc comment for
concatfunction.