Bug 1710245 Comment 3 Edit History

Note: The actual edited comment in the bug view page will always show the original commenter’s name and original timestamp.

(In reply to Lasana Murray from comment #2)
> Review of attachment 9220978 [details] [diff] [review] ⧉[details] [diff] [review]:
> -----------------------------------------------------------------
> > + * @returns {Array} All <mail-address-pill> elements in the "To" and "CC" fields.
> 
> Specify the array type here so it's clear what it actually contains (in JS
> not DOM). It may not do much now, but if we ever get into generating API
> docs from source or type checking it will be very helpful.

I'm not sure what to change here - can you propose a change?
I've tried to follow the documentation:
https://jsdoc.app/tags-returns.html
It's a plain Javascript Array of HTML Custom Elements - so {Array} looks correct, and the description provides the details.
(In reply to Lasana Murray from comment #2)
> Review of attachment 9220978 [details] [diff] [review] ⧉[details] [diff] [review]:
> > + * @returns {Array} All <mail-address-pill> elements in the "To" and "CC" fields.
> 
> Specify the array type here so it's clear what it actually contains (in JS
> not DOM). It may not do much now, but if we ever get into generating API
> docs from source or type checking it will be very helpful.

I'm not sure what to change here - can you propose a change?
I've tried to follow the documentation:
https://jsdoc.app/tags-returns.html
It's a plain Javascript Array of HTML Custom Elements - so {Array} looks correct, and the description provides the details.

Back to Bug 1710245 Comment 3