Skip to content

docs: correct streaming strike accessor and rate-limit model in shipped docs#874

Merged
userFRM merged 2 commits into
mainfrom
fix/doc-strike-dollars-and-ratelimit-docs
Jun 17, 2026
Merged

docs: correct streaming strike accessor and rate-limit model in shipped docs#874
userFRM merged 2 commits into
mainfrom
fix/doc-strike-dollars-and-ratelimit-docs

Conversation

@userFRM

@userFRM userFRM commented Jun 17, 2026

Copy link
Copy Markdown
Owner

Three shipped-doc defects, docs-only (plus one internal doc-comment line in the server router).

Streaming strike accessor — example raised AttributeError

The interactive query-builder Python recipes (Option Flow Scanner, Live Option Chain) printed the contract using c.strike_dollars, where c = event.contract is a streaming ContractRef. That accessor is no longer on the Python streaming contract payload — the surface is strike (dollars, float) plus strike_thousandths (int), as the .pyi confirms. A copy-paste of either example hit AttributeError. Both Python lines now read c.strike. The TypeScript (c.strike) and Rust (contract.strike_dollars(), the valid Rust accessor) snippets in the same component already use the correct surface and are untouched.

Rate-limit model — two docs described the removed bind-conditional limiter

tools/server/README.md and docs-site/docs/articles/error-codes.md still described the old model (auto-on for non-loopback binds, disabled on loopback, 20 rps / burst 40). The limiter is opt-in and off by default on every bind regardless of address, enabled via THETADATADX_RATE_LIMIT_PER_SECOND / THETADATADX_RATE_LIMIT_BURST_SIZE (matching docs-site/docs/server/index.md, which is already correct and is the phrasing model used here). Both docs now match, and the internal governor_error_response doc comment in tools/server/src/router.rs drops the stale "non-loopback limiter" phrasing for opt-in phrasing — no logic change.

Changelog — rc.1 missing the default flip

The 13.0.0-rc.1 Security section gained a one-line note recording the per-IP rate-limit default flip to opt-in / off-by-default, applied byte-identically to the root CHANGELOG.md and the docs-site/docs/changelog.md mirror.

Verification

  • cargo run -p thetadatadx --features config-file,__internal --bin generate_docs_site --locked -- --check → "docs site: generated pages match the registries".
  • scripts/check_docs_consistency.py → "docs consistency: ok" (it scans the .vue components for dead-API tokens).
  • cargo fmt --all -- --check → clean (the router doc comment is the only source touch).
  • Vue Python snippets sanity-checked otherwise valid; the rc.1 changelog section is byte-identical across both files.

🤖 Generated with Claude Code

claude added 2 commits June 17, 2026 21:29
…ed docs

The interactive query-builder Python recipes (Option Flow Scanner, Live Option Chain) read `c.strike_dollars` off the streaming `ContractRef`, but that accessor no longer exists on the Python streaming contract payload; it is `strike` (dollars, float) plus `strike_thousandths` (int). Pasting the example raised `AttributeError`. Both Python lines now read `c.strike`; the TypeScript and Rust snippets in the same component already use the correct surface and are untouched.

The server README and the error-codes table still described the old bind-conditional rate limiter (auto-on for non-loopback, off for loopback, 20 rps / burst 40). The limiter is opt-in and off by default on every bind regardless of address, enabled via `THETADATADX_RATE_LIMIT_PER_SECOND` / `THETADATADX_RATE_LIMIT_BURST_SIZE`; both docs now match the server reference, and the internal `governor_error_response` doc comment drops the stale "non-loopback limiter" phrasing.

The rc.1 changelog gained a Security note recording the per-IP rate-limit default flip to opt-in / off-by-default, kept byte-identical between the root ledger and the docs-site mirror.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…s-and-ratelimit-docs

# Conflicts:
#	tools/server/README.md
@userFRM userFRM merged commit 262784d into main Jun 17, 2026
6 checks passed
@userFRM userFRM deleted the fix/doc-strike-dollars-and-ratelimit-docs branch June 17, 2026 20:24
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.

2 participants