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

This comment has been minimized.

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

This comment has been minimized.

@ayushiahjolia
ayushiahjolia force-pushed the docs/migration-1x-to-2x branch from 162361b to e4ae074 Compare August 19, 2026 20:57
@ayushiahjolia
ayushiahjolia temporarily deployed to ai-pr-review-runtime August 19, 2026 20:57 — with GitHub Actions Inactive
@ayushiahjolia
ayushiahjolia temporarily deployed to ai-pr-review-runtime August 19, 2026 20:57 — 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
@github-actions

This comment has been minimized.

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

This comment has been minimized.

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 e4ae074 to 2681198 Compare August 20, 2026 17:46
@ayushiahjolia
ayushiahjolia temporarily deployed to ai-pr-review-runtime August 20, 2026 17:53 — with GitHub Actions Inactive
@ayushiahjolia
ayushiahjolia temporarily deployed to ai-pr-review-runtime August 20, 2026 17:53 — with GitHub Actions Inactive
Comment thread docs/migration-1.x-to-2.x.md
@github-actions

Copy link
Copy Markdown
Contributor

Codex AI review

Found one blocking documentation correctness issue. No runtime behavior changed; tests were not run under the read-only review constraint.

Reviewed commit 2681198af2bbfe622ad0239e24d343e066ac350d. Workflow run

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

Copy link
Copy Markdown
Contributor

Claude AI review

This is a documentation PR: a v1→v2 migration guide plus a docstring expansion on WaitForConditionConfig. I verified the guide's claims against the base-branch source.

Almost everything checks out: the error hierarchy and its package-root exports (exceptions.py, __init__.py), the callback semantics (context.py:875-909), the first-run serialize/deserialize round trip for wait_for_condition (operation/wait_for_condition.py:169-234) and the general serialize/deserialize helpers (serdes.py:444-505), the removed symbols (CallableRuntimeError, WaitDecision, ItemBatcher, InvokeConfig.timeout, ChildConfig.item_serdes, TerminationReason.CALLBACK_ERROR — none exist in the tree), the config-construction validation, and the new waits.py docstring all match the code.

One confirmed finding (see inline): the "New in 2.x: Custom Completion Predicate" section documents an API that does not exist in this repository — CompletionConfig.should_complete, complete_batch, continue_batch, CompletionStatus, CompletionDecision, CompletionOutcome, CompletionItemStatus, and the CUSTOM_COMPLETION_* outcomes. Users following that section hit ImportError/TypeError immediately.

Residual note: this is a docs-only change, so there are no code tests to add; correctness here means the documented API matches the shipped SDK.

Reviewed commit 2681198af2bbfe622ad0239e24d343e066ac350d. Workflow run

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