kit icon indicating copy to clipboard operation
kit copied to clipboard

site: `goto` parameter documentation not appearing on kit.svelte.dev

Open theetrain opened this issue 2 years ago • 2 comments

Describe the bug

Documentation for goto is missing parameter information.

Source: https://github.com/sveltejs/kit/blob/master/packages/kit/src/runtime/app/navigation.js

Screenshot_20230610-091444

Reproduction

See: https://kit.svelte.dev/docs/modules#$app-navigation-goto

Observe JSDoc info missing.

Logs

No response

System Info

(Website)

Severity

serious, but I can work around it

Additional Information

Keeping this issue open in case I don't get around to investigation/patching the issue.

theetrain avatar Jun 10 '23 13:06 theetrain

This probably needs an enhancements in the way we auto-generate these types

dummdidumm avatar Jun 30 '23 09:06 dummdidumm

It would also appear the JSDocs don't appear in VSCode, either. My theory is the generated .d.ts file doesn't replicate the docs and clobbers them.

Source

Looks good ✅

https://github.com/sveltejs/kit/blob/feb01542edd542366043bc4f3b1994e3fdb46345/packages/kit/src/runtime/client/client.js#L1694-L1707

image

Declaration

Docs are missing :x:

https://github.com/sveltejs/kit/blob/feb01542edd542366043bc4f3b1994e3fdb46345/packages/kit/types/index.d.ts#L2061-L2063

image

theetrain avatar Aug 04 '24 02:08 theetrain