From 517a35cd57e7c443b53b3f13d05eeca71438f215 Mon Sep 17 00:00:00 2001
From: metonym <ericyl.us@gmail.com>
Date: Tue, 19 Sep 2023 11:21:23 -0700
Subject: [PATCH 1/3] docs: add component comments

---
 .../docs/02-template-syntax/02-basic-markup.md         | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/documentation/docs/02-template-syntax/02-basic-markup.md b/documentation/docs/02-template-syntax/02-basic-markup.md
index e6192230d484..2a77bac0b683 100644
--- a/documentation/docs/02-template-syntax/02-basic-markup.md
+++ b/documentation/docs/02-template-syntax/02-basic-markup.md
@@ -138,3 +138,13 @@ Comments beginning with `svelte-ignore` disable warnings for the next block of m
 <!-- svelte-ignore a11y-autofocus -->
 <input bind:value={name} autofocus />
 ```
+
+You can document components with the `@component` tag. Component comments will appear when hovering over a component in your IDE using the [Svelte Language Server](https://github.com/sveltejs/language-tools).
+
+```svelte
+<!--
+@component
+This is a component description.
+-->
+<h1>Hello world</h1>
+```

From c8da51613844e6fd071118b7fb37d269ada36eaf Mon Sep 17 00:00:00 2001
From: Eric Liu <ericyl.us@gmail.com>
Date: Tue, 19 Sep 2023 11:58:42 -0700
Subject: [PATCH 2/3] Review: copy on IDE

Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
---
 documentation/docs/02-template-syntax/02-basic-markup.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/documentation/docs/02-template-syntax/02-basic-markup.md b/documentation/docs/02-template-syntax/02-basic-markup.md
index 2a77bac0b683..e6286d92cf3a 100644
--- a/documentation/docs/02-template-syntax/02-basic-markup.md
+++ b/documentation/docs/02-template-syntax/02-basic-markup.md
@@ -139,7 +139,7 @@ Comments beginning with `svelte-ignore` disable warnings for the next block of m
 <input bind:value={name} autofocus />
 ```
 
-You can document components with the `@component` tag. Component comments will appear when hovering over a component in your IDE using the [Svelte Language Server](https://github.com/sveltejs/language-tools).
+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).
 
 ```svelte
 <!--

From 19345d29611729b8d91f44bd6eb4977a735a70fb Mon Sep 17 00:00:00 2001
From: Eric Liu <ericyl.us@gmail.com>
Date: Tue, 19 Sep 2023 11:58:56 -0700
Subject: [PATCH 3/3] Review: conventions/brevity

Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>
---
 documentation/docs/02-template-syntax/02-basic-markup.md | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/documentation/docs/02-template-syntax/02-basic-markup.md b/documentation/docs/02-template-syntax/02-basic-markup.md
index e6286d92cf3a..401528cf7c1f 100644
--- a/documentation/docs/02-template-syntax/02-basic-markup.md
+++ b/documentation/docs/02-template-syntax/02-basic-markup.md
@@ -143,8 +143,7 @@ You can document components with the `@component` tag. These comments will appea
 
 ```svelte
 <!--
-@component
-This is a component description.
+@component this is a component description
 -->
 <h1>Hello world</h1>
 ```