From 44c888929197f771de7967529b52f4235d266bfb Mon Sep 17 00:00:00 2001
From: Simon H <5968653+dummdidumm@users.noreply.github.com>
Date: Wed, 23 Oct 2024 21:01:44 +0200
Subject: [PATCH] chore: tweak MountOptions docs (#13841)

A few wording tweaks, and most importantly mark `events` as deprecated - we don't want to encourage its use.
---
 packages/svelte/src/index.d.ts   | 8 +++++---
 packages/svelte/types/index.d.ts | 8 +++++---
 2 files changed, 10 insertions(+), 6 deletions(-)

diff --git a/packages/svelte/src/index.d.ts b/packages/svelte/src/index.d.ts
index 81dc936147..76ea112cd2 100644
--- a/packages/svelte/src/index.d.ts
+++ b/packages/svelte/src/index.d.ts
@@ -320,19 +320,21 @@ export type MountOptions<Props extends Record<string, any> = Record<string, any>
 	 */
 	target: Document | Element | ShadowRoot;
 	/**
-	 * Optional node inside `target` and when specified, it is used to render the component immediately before it.
+	 * Optional node inside `target`. When specified, it is used to render the component immediately before it.
 	 */
 	anchor?: Node;
 	/**
 	 * Allows the specification of events.
+	 * @deprecated Use callback props instead.
 	 */
 	events?: Record<string, (e: any) => any>;
 	/**
-	 * Used to define context at the component level.
+	 * Can be accessed via `getContext()` at the component level.
 	 */
 	context?: Map<any, any>;
 	/**
-	 * Used to control transition playback on initial render.  The default value is `true` to run transitions.
+	 * Whether or not to play transitions on initial render.
+	 * @default true
 	 */
 	intro?: boolean;
 } & ({} extends Props
diff --git a/packages/svelte/types/index.d.ts b/packages/svelte/types/index.d.ts
index df4c04db01..49ff2db8ce 100644
--- a/packages/svelte/types/index.d.ts
+++ b/packages/svelte/types/index.d.ts
@@ -317,19 +317,21 @@ declare module 'svelte' {
 		 */
 		target: Document | Element | ShadowRoot;
 		/**
-		 * Optional node inside `target` and when specified, it is used to render the component immediately before it.
+		 * Optional node inside `target`. When specified, it is used to render the component immediately before it.
 		 */
 		anchor?: Node;
 		/**
 		 * Allows the specification of events.
+		 * @deprecated Use callback props instead.
 		 */
 		events?: Record<string, (e: any) => any>;
 		/**
-		 * Used to define context at the component level.
+		 * Can be accessed via `getContext()` at the component level.
 		 */
 		context?: Map<any, any>;
 		/**
-		 * Used to control transition playback on initial render.  The default value is `true` to run transitions.
+		 * Whether or not to play transitions on initial render.
+		 * @default true
 		 */
 		intro?: boolean;
 	} & ({} extends Props