Infer the name of a destructured parameter #1704
Merged
Conversation
This file contains 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
The name of a destructured parameter can now be inferred from a JSDoc comment. The name is only inferred if the number of top-level `@param` tags in the JSDoc comment exactly matches the number of parameters. Closes TypeStrong#1703
Three additional test cases have been added to the `function` tests in the `converter` test directory. There is a test for when there are the correct number of `@param` directives, and there are tests for the cases where there is one too many or one too few `@param` directives.
|
Let me know if I can improve the tests in any way. I decided to extend the set of |
|
Looks good! I would have put the tests exactly where you did, or potentially in converter2/behavior, depending on my mood at the time. |
Gudahtt
added a commit
to MetaMask/eth-sig-util
that referenced
this pull request
May 13, 2022
A fork of `typedoc` was being used because it included an enhancement to how destructured parameters are interpreted [1]. This enhancement has since been merged and published as v0.22.5, so we don't need to use the fork anymore. [1]: TypeStrong/typedoc#1704 [2]: https://github.com/TypeStrong/typedoc/releases/tag/v0.22.5
Gudahtt
added a commit
to MetaMask/eth-sig-util
that referenced
this pull request
May 13, 2022
A fork of `typedoc` was being used because it included an enhancement to how destructured parameters are interpreted [1]. This enhancement has since been merged and published as v0.22.5 [2], so we don't need to use the fork anymore. [1]: TypeStrong/typedoc#1704 [2]: https://github.com/TypeStrong/typedoc/releases/tag/v0.22.5
Gudahtt
added a commit
to MetaMask/eth-sig-util
that referenced
this pull request
May 13, 2022
A fork of `typedoc` was being used because it included an enhancement to how destructured parameters are interpreted [1]. This enhancement has since been merged and published as v0.22.5 [2], so we don't need to use the fork anymore. [1]: TypeStrong/typedoc#1704 [2]: https://github.com/TypeStrong/typedoc/releases/tag/v0.22.5
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The name of a destructured parameter can now be inferred from a JSDoc comment. The name is only inferred if the number of top-level
@paramtags in the JSDoc comment exactly matches the number of parameters.Closes #1703