-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve JSDoc Types (Part 1) #2242
Improve JSDoc Types (Part 1) #2242
Conversation
Before you go any further, JSDoc comments should be kept as valid JSDoc, no TypeScript specific syntax. |
Noted. I'll try to see what I can do. |
For clarity, it seems like JSDoc supports Google Closure Compiler type expressions. Are we also interested in having those (e.g., generics via (I'm just trying to figure out what to remove/filter out, e.g., |
I don't think |
d2db6eb
to
797c742
Compare
Okay. The PR has become somewhat anticlimactic, but I think that all of the TypeScript syntax should be gone now. |
797c742
to
3ebc5cf
Compare
The update to |
Made the suggested change for |
Description
This is an initial amount of work for improving the JSDocs in the codebase (as mentioned in #2241).
I figured it would make more sense to apply the JSDoc improvements incrementally. This has a few benefits:
Note: If the preference is only to merge everything at once, then this PR can be kept in a Draft State until it is "sufficiently complete".
Additional Notes
When using JSDocs, TypeScript is fine with using
String
orstring
,*
orany
, and the like interchangeably. Not as idiomatic, but I'm not focused on that at the moment.