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

Missing documentation for @... notations? #48

Open
jasonkuhrt opened this issue Aug 15, 2024 · 1 comment
Open

Missing documentation for @... notations? #48

jasonkuhrt opened this issue Aug 15, 2024 · 1 comment

Comments

@jasonkuhrt
Copy link

Hey,

I've integrated VitePress and Twoslash, thanks for all the work you've done here.

IIUC things like @log are styled when e.g. using ts twoslash. However, it seems that these @ notations are not documented in Twoslash website.

I would be happy to make a contribution to the docs if I am correct. But perhaps I am misunderstanding where the @log etc. functionality originates from.

Also another example here https://shiki.style/packages/twoslash:

CleanShot 2024-08-15 at 10 44 57@2x

@jasonkuhrt jasonkuhrt changed the title Missing documentation for @... notation? Missing documentation for @... notations? Aug 15, 2024
@jasonkuhrt
Copy link
Author

Ok, so nicely it seems that there is at least inline doc for @ notations. That's great!

CleanShot 2024-08-15 at 11 05 24@2x

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant