Open
Bug 1802978
Opened 4 months ago
Updated 4 months ago
Migration JSDoc comments should be more precise about array types
Categories
(Firefox :: Migration, task, P1)
Firefox
Migration
Tracking
()
NEW
People
(Reporter: mconley, Unassigned)
References
Details
In https://phabricator.services.mozilla.com/D163133#inline-899335, kpatenio noted that we're being a bit inconsistent about how we declare array parameters and return types in some of our JSDoc. In some places, we're using things like @returns {object[]}
and in others, we're using @returns {Array}
.
I agree with her that we should try to be more consistent here, and try to update our documentation to use the former variant when possible to make it clearer what array parameters and return types contain.
Updated•4 months ago
|
Severity: -- → S3
Priority: -- → P1
You need to log in
before you can comment on or make changes to this bug.
Description
•