The Wayback Machine - https://web.archive.org/web/20220208082847/https://github.com/sveltejs/svelte/issues/7230
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

more jsdoc documentation for runtime parts #7230

Open
ehsan2003 opened this issue Feb 7, 2022 · 1 comment
Open

more jsdoc documentation for runtime parts #7230

ehsan2003 opened this issue Feb 7, 2022 · 1 comment

Comments

@ehsan2003
Copy link

@ehsan2003 ehsan2003 commented Feb 7, 2022

Describe the problem

the low level documentation (https://svelte.dev/docs) is not really easy to use ( and incomplete in some cases)
I think if the runtime function contain JSDOC it will help a lot and give the developers an easier way to discover api documentation

additionally it is possible to replace the https://svelte.dev/docs with the generated docs ( with some thing like https://typedoc.org/ )

I am not sure but it would also make svelte maintainers life easier because keeping the docs with code might be a pain 🤷‍♂️

Describe the proposed solution

add JSDOC for runtime functions
It wont take too much of time because text already exists in svelte.dev/docs

Alternatives considered

I have no idea about alternatives :)

Importance

would make my life easier

@bluwy
Copy link
Member

@bluwy bluwy commented Feb 8, 2022

I think it is a good addition, though it would bear more maintenance work to make sure docs are updated in both places. Still would be better for the end-users though.

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

Successfully merging a pull request may close this issue.

None yet
2 participants