Repository navigation
docs: clarify corporate-action and futures cash migration boundaries - #154
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Closes #153. Clarify the existing migration, accounts and data references without changing runtime behavior. Reviewed head:
b678e7010c43176684711dcbfb0b1293f343a405.The perpetual-contract tutorial previously described a generic futures accounting convention. It now names Backtest's full-notional cash model. The migration guide distinguishes prepared prices from raw corporate-action entitlement/share ledgers, and contract P&L/margin from variation cash. It also states the retained CME input's missing dated-chain/roll-map limitation without implying that Zipline lacks futures support.
Evidence
e74bed7and calendar source391cc8areproduce long/short cash of -$100,000/$300,000 and equity of $100,500/$99,500 for the declared one-contract 4,000-to-4,010 move with multiplier 50. The behavior agrees with the existing notional ledger. No runtime defect or terminal-equity parity claim is inferred.Reference methods were checked against primary CME/CFTC material and the pinned Zipline 3.1.1 ledger source. The public account guide links the accessible CFTC definition. Zipline marks futures payouts during portfolio valuation; the prose does not equate that cadence with daily exchange settlement.
Scope and AI assistance
Only three documentation files change. No event-processing API, settlement mode, default, dependency, performance report, redirect or publication is changed. Implementing missing raw-action or settlement workflows remains a separate capability decision; this documentation does not implement them.
Codex inspected source/primary references, executed the public workflows and drafted the correction. This is maintainer-directed AI assistance, with actual checks distinguished from pending checks.