docgen: Find parameters by index rather than name and handle array destructuring #29945
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
|
Size Change: +1.07 kB (0%) Total Size: 1.42 MB
ℹ️ View Unchanged
|
gziolo
added
[Package] Docgen
sarayourfriend
changed the title
5 tasks
noahtallen
reviewed
Apr 7, 2021
packages/docgen/test/fixtures/type-annotations/array-destructuring-any-other-type/example.ts
Show resolved
Hide resolved
| @@ -19,7 +22,7 @@ describe( 'Type annotations', () => { | |||
| type: 'number', | |||
| }; | |||
| const node = {}; | |||
| const result = getTypeAnnotation( tag, node ); | |||
| const result = getTypeAnnotation( tag, node, 0 ); | |||
There was a problem hiding this comment.
What do you think about making the default param for index be 0? (Or maybe it makes more sense to just be explicit, idk)
noahtallen
reviewed
Apr 8, 2021
sarayourfriend
force-pushed
the
fix/missing-param-types-docgen
branch
from
1e9391a
to
a8a0b12
Compare
noahtallen
approved these changes
Apr 8, 2021
|
Thanks @noahtallen! FWIW the best way to test docgen is to run |
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.
Description
See the solution proposed in #29944. This PR implements that solution.
Partially fixes #29944 for array destructuring but not for object destructuring. Object destructuring will happen in a separate PR to reduce the size of the PRs.
How has this been tested?
npm run docs:buildshould have no changes (docs continue to build successfully as they were before).Types of changes
Bug fix.
Checklist: