Use forked tsify branch to copy rustdoc comments over to web TS types #1761
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
sisou
force-pushed
the
sisou/web-client-tsify-comments
branch
from
4b7db0b to
fde524c
Compare
jsdanielh
approved these changes
Aug 17, 2023
|
Rebasing to get it merged |
jsdanielh
force-pushed
the
sisou/web-client-tsify-comments
branch
from
fde524c to
6feaae9
Compare
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.
When generating the web-client Typescript type definitions, we use both
wasm-bindgenandtsifyfor generating types.wasm-bindgen-annotated structs correctly carry their rustdoc comments over, buttsify-tagged ones were not.I added this functionality to tsify in my fork, which the web-client switches to in this PR.
Having the comments in the generated type definitions benefits developers who can see the comments when hovering over the types in their TS projects in IDEs.