From d76aefd8b04fda6b9e2219399dfdd347b269fb2a Mon Sep 17 00:00:00 2001
From: Dimitri POSTOLOV <dmytropostolov@gmail.com>
Date: Mon, 24 Mar 2025 22:42:21 +0100
Subject: [PATCH 1/2] upd

---
 packages/react/src/types/edges.ts | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/packages/react/src/types/edges.ts b/packages/react/src/types/edges.ts
index 4d1e3f04..3b922796 100644
--- a/packages/react/src/types/edges.ts
+++ b/packages/react/src/types/edges.ts
@@ -23,7 +23,11 @@ import { EdgeTypes, InternalNode, Node } from '.';
  * @inline
  */
 export type EdgeLabelOptions = {
-  label?: string | ReactNode;
+  /**
+   * The label or custom element to render along the edge. This is commonly a text label or some
+   * custom controls.
+   */
+  label?: ReactNode;
   labelStyle?: CSSProperties;
   labelShowBg?: boolean;
   labelBgStyle?: CSSProperties;
@@ -136,13 +140,20 @@ export type EdgeProps<EdgeType extends Edge = Edge> = Pick<
  */
 export type BaseEdgeProps = Omit<SVGAttributes<SVGPathElement>, 'd'> &
   EdgeLabelOptions & {
-    /** Additional padding where interacting with an edge is still possible */
+    /**
+     * The width of the invisible area around the edge that the user can interact with. This is
+     * useful for making the edge easier to click or hover over.
+     */
     interactionWidth?: number;
     /** The x position of edge label */
     labelX?: number;
     /** The y position of edge label */
     labelY?: number;
-    /** SVG path of the edge */
+    /**
+     * The SVG path string that defines the edge. This should look something like
+     * `'M 0 0 L 100 100'` for a simple line. The utility functions like `getSimpleBezierEdge` can
+     * be used to generate this string for you.
+     */
     path: string;
   };
 

From 7eb6eb0709e451d7628bfdbc3ced89b3bb57b626 Mon Sep 17 00:00:00 2001
From: Dimitri POSTOLOV <dmytropostolov@gmail.com>
Date: Mon, 24 Mar 2025 22:43:32 +0100
Subject: [PATCH 2/2] Create forty-phones-lick.md

---
 .changeset/forty-phones-lick.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 .changeset/forty-phones-lick.md

diff --git a/.changeset/forty-phones-lick.md b/.changeset/forty-phones-lick.md
new file mode 100644
index 00000000..86132fa3
--- /dev/null
+++ b/.changeset/forty-phones-lick.md
@@ -0,0 +1,5 @@
+---
+"@xyflow/react": patch
+---
+
+fix: improve TSDoc comments for `EdgeLabelOptions` and `BaseEdgeProps`