Skip to content

docs: identify released migration inputs and consumer boundaries - #138

Merged
stefan-jansen merged 2 commits into
mainfrom
docs/released-migration-handoffs
Oct 26, 2026
Merged

stefan-jansen merged 2 commits into
mainfrom
docs/released-migration-handoffs

Conversation

@stefan-jansen

Copy link
Copy Markdown
Contributor

Closes #137.

The published migration guide still describes Data 0.3.0 APIs as unreleased and recommends an older Engineer development checkout. Identify the released APIs, link the immutable release examples, and provide the Data input handoffs for Diagnostic and Backtest. Keep prior cross-library checks explicitly historical and preserve all adjustment, missing-data and runtime/account boundaries.

Documentation only: no package API, dependency, numerical definition or runtime behavior changes.

Verification at 2eb2e62:

  • Fresh public PyPI Data 0.3.0 installation passed all six native migration examples with ResourceWarning treated as error; actual public wheel and source archive hashes match the retained release.
  • Released native and compatibility imports succeed without importing Zipline. The already-qualified 13 real Zipline reader/writer cases remain unchanged; the current automation PR also passes that installed conversion lane.
  • Strict MkDocs, README links, final rendered source identity/internal/external links, and all pre-commit hooks pass.
  • Full runtime suites are reused from the identical runtime tree; this change modifies only the existing migration guide. Hosted current-head checks are still required before merge.

The live guide is still the 0.3.0 deployment. This PR prepares its correction; it does not deploy documentation or publish a package. Merge ordering must preserve the currently qualified release source until its release-security decision is resolved.

AI assistance: Codex reproduced the live-documentation mismatch, edited this guide and executed the listed verification. Maintainer-directed review covers every changed statement; historical consumer evidence has not been promoted into a new compatibility claim.

Correct stale unreleased wording for Data 0.3.0, link release examples, and distinguish historical integration checks from released Data availability. Keep Diagnostic analytics and Backtest runtime/account responsibilities explicit.

Closes #137
Copilot AI balanced review requested due to automatic review settings October 26, 2026 14:10

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@stefan-jansen
stefan-jansen merged commit 60a8ad2 into main Oct 26, 2026
28 checks passed
@stefan-jansen
stefan-jansen deleted the docs/released-migration-handoffs branch October 26, 2026 19:21
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.

docs: identify released migration inputs and consumer boundaries

2 participants