Skip to content

docs: add note about @component #14561

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.

Sign up for GitHub

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

Jump to bottom
Closed
Rich-Harris wants to merge 1 commit into from
Closed

docs: add note about @component #14561

Rich-Harris wants to merge 1 commit into from

Conversation

@Rich-Harris
Copy link
Member

@Rich-Harris Rich-Harris commented Dec 4, 2024

closes #14560 (I know the issue talks about having a separate page, but it feels like overkill — I think it's fine to have it here)

@changeset-bot
Copy link

changeset-bot bot commented Dec 4, 2024

⚠️ No Changeset found

Latest commit: c8504b0

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@Rich-Harris
Copy link
Member Author

Rich-Harris commented Dec 4, 2024

preview: https://svelte-dev-git-preview-svelte-14561-svelte.vercel.app/

this is an automated message

@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2024

Playground

pnpm add https://pkg.pr.new/svelte@14561

benmccann
benmccann requested changes Dec 4, 2024
View reviewed changes
documentation/docs/03-template-syntax/01-basic-markup.md
</main>
````

You can document components with the `@component` tag. These comments will appear when hovering over a component in IDEs with support such as VS Code with [the Svelte VS Code extension](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
Copy link
Member

@benmccann benmccann Dec 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is duplicate of the section right above it

Copy link
Member Author

@Rich-Harris Rich-Harris Dec 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh!

@benmccann
Copy link
Member

benmccann commented Dec 4, 2024

I think we can probably close this as I didn't realize it already existed in the docs. I closed the issue

@Rich-Harris Rich-Harris closed this Dec 4, 2024
@dummdidumm dummdidumm deleted the document-component-descriptions branch December 4, 2024 20:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benmccann benmccann benmccann requested changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs: add page for component comments

3 participants

@Rich-Harris @benmccann