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

Include example URLs in JSDocs #146

Open
fregante opened this issue Aug 4, 2022 · 1 comment
Open

Include example URLs in JSDocs #146

fregante opened this issue Aug 4, 2022 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@fregante
Copy link
Member

fregante commented Aug 4, 2022

It would be good to expose the example/test URLs in the JSDocs:

Screen Shot

I'm not sure how how to do this automatically though:

  • write the test URLs in JSDocs and have the test runner read them (how?!). This has the advantage of "just working" when building it via TS
  • manually extending the types via build, either via typescript transform or via post-build step (gives me a headache just thinking about it)

Something similar was suggested by @kidonng on the RG repo if I remember correctly.

Current situation:

Screen Shot

@fregante fregante added enhancement New feature or request help wanted Extra attention is needed labels Aug 4, 2022
@fregante
Copy link
Member Author

fregante commented Aug 5, 2022

  • have the test runner read them (how?!)

Extracting JSDoc comments also looks like a nightmare: https://github.com/microsoft/tsdoc/blob/8b0d97f06009ab8fe086aed237b2c3a878d9d9e1/api-demo/src/advancedDemo.ts#L255

The alternative of editing the d.ts files in place suddenly looks like a walk in the park.

Edit: I asked in https://github.com/microsoft/tsdoc/issues/332

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Development

No branches or pull requests

1 participant