Skip to content
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 type information of internal functions #813

Merged
merged 3 commits into from
Jul 20, 2020

Conversation

ankon
Copy link
Contributor

@ankon ankon commented Jul 10, 2020

These were "fallout" while working on KIP-392 (see #810), but can be treated as independent to hopefully simplify reviewing/merging.

@Nevon
Copy link
Collaborator

Nevon commented Jul 20, 2020

Interesting. I didn't know you could import Typescript types from within JSDoc comments.

@Nevon Nevon merged commit 9a6cc1b into tulios:master Jul 20, 2020
@ankon
Copy link
Contributor Author

ankon commented Jul 20, 2020

While trying to find a reference: There's probably a caveat here that this syntax comes from TypeScript, and right now the JSDoc people haven't implemented it (but it seems they're not actively against it either):

@ankon ankon deleted the pr/typing-improvements-0720 branch July 20, 2020 15:49
@Nevon
Copy link
Collaborator

Nevon commented Jul 20, 2020

Since we're not generating docs from the JSDoc comments, and only rely on it for IDE support, I think it's fine. VSCode seems to mostly get it (although amusingly hovering over @type shows you this person's github profile 😂)

Screenshot 2020-07-20 at 17 30 54

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants