Use lowercase for primitives in jsdocs#6033
Conversation
|
Is this recommended by JSDocs? |
|
I don't think jsdoc necessarily cares. I was mostly doing this for consistency with #6020 Typescript cares, so this may make it easier to support in the future: https://www.typescriptlang.org/docs/handbook/declaration-files/do-s-and-don-ts.html |
kurkle
left a comment
There was a problem hiding this comment.
Didn't go through all, but I think Object should still be capitalized. Also noticed there are issues with the jsdocs, so maybe it would better to remove all but
/**
* @private
* /
from private functions.
I don't have any strong feelings about these, so this review should be regarded as a comment rather than a request for changes.
|
Our docs use lowercase object as does typescript, so I think lowercase would be more consistent |
|
Chart.js/src/core/core.scale.js Line 719 in 6e9e52a rectangle also an interface?
|
|
@nagix I fixed the |
|
There are a few other lines that have JSDoc-style comments but start with |
|
Ok. I've changed all the rest as well. Thanks for catching that |
|
I realized that those blocks all don't have types. Types are not required in JSDoc, but it might be better to include for consistency (and |
|
Ok, I've gone through and replaced the |
343e380 to
ed49930
Compare
nagix
left a comment
There was a problem hiding this comment.
Thanks for all the changes, looks good to me.
99123dd to
4f49e41
Compare
nagix
left a comment
There was a problem hiding this comment.
Thanks for all the cleanups!
|
Thanks for the reviews! |
No description provided.