-
-
Notifications
You must be signed in to change notification settings - Fork 4k
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
docs: add component comments #7376
base: svelte-4
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yep, seems like a good thing to document!
My gut instinct is that, until we have more documentation of ancillary tooling on svelte.dev, that this isn't the sort of thing that should live here. It's not part of the core Svelte language, and the compiler ignores it. If this is documented somewhere else, like in the language tools repo somewhere, I could get behind having a link to that. I know at some point we had a vision of separate tabs on the svelte.dev site for all of the different official bits of tooling (generated in some way from markdown files in individual repos), but I'm not sure whether that's still something we see happening now that we've moved away from the centralized docs API. |
In my mind this is part of the Svelte spec and so it does belong here. There are a number of different tools that may have to understand this syntax. Documenting it just for a single tool doesn't seem sufficient. Those tools should probably link back to docs living here instead |
8de4ec1
to
517a35c
Compare
|
I've rebased on |
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
I find
@component
comments to be highly useful. I actually wasn't aware it was supported by the Svelte Language Server until recently.When visiting the documentation site, I cannot find documentation on component comments using a
command + f
search. Currently, component comments are only documented in the FAQs section.This PR adds documentation for component comments to the Comments section.