Skip to content

Docs/migration 1x to 2x - #655

Open
ayushiahjolia wants to merge 1 commit into
mainfrom
docs/migration-1x-to-2x
Open

Docs/migration 1x to 2x#655
ayushiahjolia wants to merge 1 commit into
mainfrom
docs/migration-1x-to-2x

Conversation

@ayushiahjolia

Copy link
Copy Markdown
Contributor

Issue #, if available: N/A

Description of changes:
Migration guide for python v2

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@ayushiahjolia
ayushiahjolia force-pushed the docs/migration-1x-to-2x branch from 31f5f5e to 162361b Compare August 18, 2026 21:38
@ayushiahjolia
ayushiahjolia marked this pull request as ready for review August 18, 2026 21:39
@ayushiahjolia
ayushiahjolia temporarily deployed to ai-pr-review-runtime August 18, 2026 21:39 — with GitHub Actions Inactive
@ayushiahjolia
ayushiahjolia temporarily deployed to ai-pr-review-runtime August 18, 2026 21:39 — with GitHub Actions Inactive
Comment thread docs/migration-1.x-to-2.x.md
Comment thread docs/migration-1.x-to-2.x.md Outdated
Comment thread docs/migration-1.x-to-2.x.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Codex AI review

Found three migration-guide issues: unavailable APIs, a crashing callback example, and replay-unsafe logging. Documentation snippets lack automated validation.

Reviewed commit 162361bd075ac0b1ad3f1ebfaad8191a3c901d14. Workflow run

Comment thread docs/migration-1.x-to-2.x.md
Comment thread docs/migration-1.x-to-2.x.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

Claude AI review

Documentation-only PR: a 1.x→2.x migration guide plus a WaitForConditionConfig docstring addition. The base branch already carries the 2.x API surface, so I verified each concrete claim against packages/aws-durable-execution-sdk-python/src/. Most claims are accurate (typed DurableOperationError hierarchy, RetryableSerDesError/SerDesError exports, WaitForConditionDecision.continue_waiting/stop_polling, BatchResult.throw_if_error() raising ChildContextError, ChildConfig.serdes, removal of InvokeConfig.timeout*, CompletionConfig.all_completed() tolerating all failures). Two claims are wrong against the source and would break copy-pasted code:

  • docs/migration-1.x-to-2.x.md:112-147 — "Custom Completion Predicate" documents a non-existent API. CompletionConfig (config.py:102) has no should_complete field, and none of complete_batch, continue_batch, CompletionStatus, CompletionDecision, CompletionOutcome, CompletionItemStatus, or CUSTOM_COMPLETION_* exist anywhere in the repo. The documented import raises ImportError and the constructor call raises TypeError.
  • docs/migration-1.x-to-2.x.md:82-83e.callback_id is not a real attribute. No CallbackError raise site sets it and the base DurableOperationError.__init__ doesn't define it, so the example raises AttributeError.

Per AGENTS.md ("when the developer guide and the source disagree, trust the source and report the discrepancy"), both are reported below. No test risk applies to a docs change, but the guide should not ship examples that fail on execution.

Reviewed commit 162361bd075ac0b1ad3f1ebfaad8191a3c901d14. Workflow run

Add docs/migration-1.x-to-2.x.md covering the 2.x breaking changes: typed
per-operation error hierarchy, first-run serialize/deserialize round trip,
removed config types and fields, construction-time config validation, and
wait_for_condition changes; plus the optional should_complete feature.
Also document the initial_state serdes requirement on WaitForConditionConfig.
@ayushiahjolia
ayushiahjolia force-pushed the docs/migration-1x-to-2x branch from 162361b to e4ae074 Compare August 19, 2026 20:57
@ayushiahjolia
ayushiahjolia requested a deployment to ai-pr-review-runtime August 19, 2026 20:57 — with GitHub Actions In progress
@ayushiahjolia
ayushiahjolia deployed to ai-pr-review-runtime August 19, 2026 20:57 — with GitHub Actions Active
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