From 8b80a0a269926f237cd7827b70ccd505ec0ef242 Mon Sep 17 00:00:00 2001
From: "Raduan A." <36044389+0xRaduan@users.noreply.github.com>
Date: Sun, 9 Nov 2025 17:37:16 +0100
Subject: [PATCH] Fix SDK documentation: replace 'file diffs' with 'file change
 notifications' (#6425)

The TypeScript SDK's README incorrectly claimed that runStreamed() emits
"file diffs". However, the FileChangeItem type only contains metadata
(path, kind, status) without actual diff content.

Updated line 36 to accurately describe the SDK as providing "file change
notifications" instead of "file diffs" to match the actual
implementation in items.ts.

Fixes #5850
---
 sdk/typescript/README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sdk/typescript/README.md b/sdk/typescript/README.md
index df368923..967beed1 100644
--- a/sdk/typescript/README.md
+++ b/sdk/typescript/README.md
@@ -33,7 +33,7 @@ const nextTurn = await thread.run("Implement the fix");
 
 ### Streaming responses
 
-`run()` buffers events until the turn finishes. To react to intermediate progress—tool calls, streaming responses, and file diffs—use `runStreamed()` instead, which returns an async generator of structured events.
+`run()` buffers events until the turn finishes. To react to intermediate progress—tool calls, streaming responses, and file change notifications—use `runStreamed()` instead, which returns an async generator of structured events.
 
 ```typescript
 const { events } = await thread.runStreamed("Diagnose the test failure and propose a fix");