Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add support for typescript-style docstrings #4507

Merged
merged 1 commit into from Nov 13, 2020

Conversation

boneskull
Copy link
Member

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)

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 <boneskull@boneskull.com>
@boneskull boneskull added area: documentation anything involving docs or mochajs.org type: chore generally involving deps, tooling, configuration, etc. semver-patch implementation requires increase of "patch" version number; "bug fixes" labels Nov 12, 2020
@boneskull boneskull self-assigned this Nov 12, 2020
@coveralls
Copy link

Coverage Status

Coverage remained the same at 94.061% when pulling 4ddcf04 on boneskull/jsdoc-ts-support into 025fc2e on master.

@boneskull boneskull merged commit 6d3fe26 into master Nov 13, 2020
@boneskull boneskull deleted the boneskull/jsdoc-ts-support branch November 13, 2020 18:20
@boneskull boneskull added this to the next milestone Nov 13, 2020
@juergba juergba modified the milestones: next, v8.3.0 Feb 11, 2021
This was referenced Mar 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation anything involving docs or mochajs.org semver-patch implementation requires increase of "patch" version number; "bug fixes" type: chore generally involving deps, tooling, configuration, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants