Skip to content

Commit 8474292

Browse files
jssmithclaude
andcommitted
workflow_streams: tighten README intro and fix samples link
Drop the payload/codec paragraph from the README intro — it duplicates material that the docs site guide already covers. Update the samples link to the new workflow-streams directory and the docs link to the libraries section. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 587f638 commit 8474292

1 file changed

Lines changed: 4 additions & 7 deletions

File tree

temporalio/contrib/workflow_streams/README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,17 @@ long-poll subscriptions, and a Query exposes the current global offset.
1717
The library packages the boilerplate that turns those primitives into
1818
a usable stream: batching to amortize per-event overhead, deduplication
1919
for exactly-once delivery, topic filtering, and continue-as-new helpers
20-
that hand stream state across Workflow runs. Payloads ride as Temporal
21-
`Payload`s so codec chains (encryption, compression) run once on the
22-
signal/update envelope — never per item — and typed decode is available
23-
to subscribers via `result_type=T`.
20+
that hand stream state across Workflow runs.
2421

2522
## Documentation
2623

2724
📖 **The full guide lives in the Temporal documentation site:**
28-
**[Workflow Streams — Python SDK](https://docs.temporal.io/develop/python/workflows/workflow-stream)**
25+
**[Workflow Streams — Python SDK](https://docs.temporal.io/develop/python/libraries/workflow-streams)**
2926

3027
It covers installation, enabling streaming on a Workflow, publishing from
3128
Workflows and Activities, subscribing, continue-as-new, delivery semantics,
3229
codec and payload encoding, architecture, and caveats — with runnable code
3330
snippets throughout.
3431

35-
For a runnable end-to-end example, see the
36-
[Workflow Streams sample](https://github.com/temporalio/samples-python/tree/main/pubsub).
32+
For runnable end-to-end examples, see the
33+
[Workflow Streams samples](https://github.com/temporalio/samples-python/tree/main/workflow-streams).

0 commit comments

Comments
 (0)