Repository navigation
Conversation
This was referenced Apr 8, 2018
Closed
Contributor
|
Thank you for your pull request! The most important CI builds succeeded, we’ll review the pull request soon. |
Member
|
This is weird, and probably makes the code less readable. This should be fixed on typescript side. I would accept a name tag in the arguments list like this: ...
/** @param opts */ { name, type, fn }But the jsdoc should still list all items. |
Contributor
Author
|
🎉 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What kind of change does this PR introduce?
Refactor
Did you add tests for your changes?
No
If relevant, link to documentation update:
N/A
Summary
This is part of #6862
The way JSDoc works with TypeScript is a bit different and we want to make sure that TypeScript can understand our JSDoc.
I'm asking the TypeScript team to make it easier to work with destructuring parameters. See microsoft/TypeScript#11597. Until that issue resolves, this is an intermediate solution.
Does this PR introduce a breaking change?
No, just comment changes