Open Bug 1802978 Opened 1 year ago Updated 1 year ago

Migration JSDoc comments should be more precise about array types


(Firefox :: Migration, task, P1)





(Reporter: mconley, Unassigned)



In, 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.

Severity: -- → S3
Priority: -- → P1
You need to log in before you can comment on or make changes to this bug.