Skip to content

docs(python): correct 2.0 semantics in four pages - #284

Open
yaythomas wants to merge 1 commit into
mainfrom
docs/python-2.0-corrections
Open

docs(python): correct 2.0 semantics in four pages#284
yaythomas wants to merge 1 commit into
mainfrom
docs/python-2.0-corrections

Conversation

@yaythomas

Copy link
Copy Markdown
Contributor

Corrects four claims against the released Python SDK 2.0 source (and the JS SDK for the shared map page).

Changes

  1. map.md The Python completion_config bullet claimed the default is lenient ("all items run regardless of failures"). The default fails the batch on the first failed item, verified against CompletionPolicy.is_tolerance_exceeded (an empty config treats any failure as exceeding tolerance). The TypeScript completionConfig bullet had the same problem ("wait for all items") and is fixed too, verified against the JS handler's completion logic. This is the same error fixed in the SDK docstring in Docs/migration 1x to 2x aws-durable-execution-sdk-python#655 review.
  2. map.md, parallel.md max_concurrency bounds in-flight items, not merely "running" items: a suspended item (awaiting an invoke or callback) keeps its slot until it completes.
  3. wait-for-condition.md On resume, a SerDes that fails to deserialize stored polling state fails the operation. Previously the page only covered the first-run round trip of initialState.
  4. callback.md wait_for_callback runs in a child context that serializes the result with the default SerDes, so a custom SerDes return value must also serialize with the default SerDes, or the child raises SerDesError.

Not changed

Java and C# completion-default wording on the map page. Those SDKs were not verified for this change; if their defaults are also fail-fast, the same one-line fix applies.

All claims verified against SDK source: CompletionPolicy in concurrency/models.py, the coordinator loop in concurrency/executor.py, operation/wait_for_condition.py, and operation/callback.py / wait_for_callback_handler.

@yaythomas
yaythomas deployed to ai-pr-review-runtime September 8, 2026 22:08 — with GitHub Actions Active
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 22:08 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 22:08 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 22:23 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 22:23 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 22:42 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 22:42 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 22:54 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 22:54 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 23:06 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 23:06 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 23:09 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 23:09 — with GitHub Actions Failure
@yaythomas
yaythomas force-pushed the docs/python-2.0-corrections branch from f8bcdae to a499202 Compare September 8, 2026 23:10
The default completion config fails the batch on the first failed
item, in Python and TypeScript alike. max_concurrency caps in-flight
items and a suspended item keeps its slot. A SerDes that fails to
deserialize stored polling state fails wait_for_condition. A custom
callback SerDes result must serialize with the default SerDes.
Behavior moved to shared prose so the language tabs stay symmetric.

Java and C# completion-default wording was left untouched; those
SDKs were not verified for this change.
@yaythomas
yaythomas force-pushed the docs/python-2.0-corrections branch from a499202 to 01750fe Compare September 8, 2026 23:11
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 23:12 — with GitHub Actions Failure
@yaythomas
yaythomas had a problem deploying to ai-pr-review-runtime September 8, 2026 23:12 — with GitHub Actions Failure
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant