Skip to content

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

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

Open
theetrain opened this issue Jun 10, 2023 · 2 comments
Open

Comments

@theetrain
Copy link

theetrain commented Jun 10, 2023

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://svelte.dev/docs/kit/$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.

@dummdidumm
Copy link
Member

dummdidumm commented Jun 30, 2023

This probably needs an enhancements in the way we auto-generate these types Rich-Harris/dts-buddy#92

@eltigerchino eltigerchino changed the title goto parameter documentation not appearing on kit.svelte.dev site: goto parameter documentation not appearing on kit.svelte.dev Jun 7, 2024
@theetrain
Copy link
Author

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 ❌

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

image

@eltigerchino eltigerchino transferred this issue from sveltejs/kit Oct 26, 2024
@linear linear bot added the svelte.dev label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants