add support for typescript-style docstrings #4507
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
this change adds [jsdoc-ts-utils](https://npm.im/jsdoc-ts-utils), which I have had success using in [mrca](https://npm.im/mrca). it allows us to use the `import()` syntax to reference types in other modules, and other things that make working in a TS-language-server-enabled editor much nicer. it does not support _all_ of the stuff TS does, but at least helps. this should not change the API documentation output (at least until we start using the new supported features) Signed-off-by: Christopher Hiller <[email protected]>
boneskull
added
area: documentation
This was referenced Mar 6, 2021
Closed
This was referenced Mar 15, 2021
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.
this change adds jsdoc-ts-utils, which I have had success using in mrca. it allows us to use the
import()syntax to reference types in other modules, and other things that make working in a TS-language-server-enabled editor much nicer.it does not support all of the stuff TS does, but at least helps.
this should not change the API documentation output
(at least until we start using the new supported features)