Copy rustdoc comments over to TS output #32
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
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.
Fixes #14.
This PR adds the ability for tsify to detect and transfer rustdoc (
/// ...) comments into the TS output and attach them to the type definitions, so users can see them in their IDE when they hover over variables in their Typescript code.Inspired by the same functionality in
wasm-bindgen.About the Tests
For this PR, I have added comments into all tests. As you can see, I took great care to only add comments, not change tsify's output formatting for the types itself.
If you don't like comments in all your tests, I can create a separate test file just for comments instead and put most of them in there. Let me know 😉
cargo fmt