docs: align stale snippets with the shipped API and drop provenance prose#800
Merged
Conversation
…rose The interactive docs-site query builder generated Rust streaming snippets against the old FpssEvent / FpssData type names; rename them to the shipped StreamEvent / StreamData enums so the generated code compiles. Correct the TypeScript readme tip to the real inline-credentials form (a Credentials value passed to connect), point the gated Python streaming-network probe at the historical sub-namespace where the snapshot endpoint now lives, drop a wire-protocol provenance sentence from the proto maintenance note that ships in the crate, and reword two C ABI readme rows to name the streaming delivery thread without internal-dispatch vocabulary. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
2 participants
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.
Final-round audit follow-up (the LOW doc/prose nits the second auditor surfaced). None are correctness defects in product code; all are in non-shipped or doc artifacts, but they are real staleness/hygiene issues worth closing for a pristine release.
QueryBuilder.vuegenerated Rust streaming snippets used the removedFpssEvent/FpssDatanames; renamed to the shippedStreamEvent/StreamDataenums (re-exported fromthetadatadx::fpss) so the generated code compiles.sdks/typescript/README.mdtip advertisedconnect(email, password); corrected toconnect(new Credentials(email, password))to match the real signature (the code block beneath was already correct).sdks/python/tests/test_no_gil.pycalledclient.stock_snapshot_quote(...)on the unified client; the snapshot endpoints now live underclient.historical, so the gated network probe is repointed.crates/thetadatadx/proto/MAINTENANCE.md(shipped in the crateincludelist) dropped a wire-protocol provenance sentence.ffi/README.mdreworded two rows to name the streaming delivery thread without internal-dispatch vocabulary.Gates pass:
check_no_re_framing.py,check_public_surface_leak.py,check_docs_consistency.py,check_doc_defaults.py.🤖 Generated with Claude Code