Skip to content

Commit c78787b

Browse files
committed
Fix SDK documentation: replace 'file diffs' with 'file change notifications'
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
1 parent 917f39e commit c78787b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

sdk/typescript/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ const nextTurn = await thread.run("Implement the fix");
3333

3434
### Streaming responses
3535

36-
`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.
36+
`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.
3737

3838
```typescript
3939
const { events } = await thread.runStreamed("Diagnose the test failure and propose a fix");

0 commit comments

Comments
 (0)