docs: 100% accuracy pass for v4.1.0#450
Conversation
Document the 4.1.0 additions and fix a stale verb: - communications: block_trade_proposals sub-resource (quick-ref rows, a worked example section, mkdocstrings directives) + quotes min_ts/max_ts; fix quotes.accept/confirm verb (PUT, not POST) in the quick-ref table - account: volume_progress() (quick-ref row + section) - events: tickers filter (example + prose) - perps: MarginMarket mark-price fields + new TickerPrice model; required MarginPosition.subaccount - reference / request-models: new request models in the curated lists Verified: mkdocs build --strict passes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Code Review -- docs: 100% accuracy pass for v4.1.0Overall: Clean documentation-only PR. The new content is accurate, code examples match the implementation, and the POST->PUT verb fix is a genuine correctness improvement. No blocking issues. Correctness checks (verified against source)POST -> PUT fix (quotes.accept / quotes.confirm) - PASS Block trade proposals examples - PASS
volume_progress() example - PASS Minor issues1. Path parameter inconsistency (communications.md quick-ref table) 2. expiration_ts example passes a bare string (communications.md) 3. Wire-format detail leaks into user docs (events.md) Nits
Summary: Ready to merge with optional polish on items 1-3. The verb fix alone justifies landing this. |
- communications: accept quick-ref row uses the named path param
{block_trade_proposal_id} (matches the spec + the other rows), not {id}
- events: trim wire-format jargon on the tickers filter, keep the comma constraint
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Code Review —
|
Summary
100% docs accuracy pass for v4.1.0 — documents every 4.1.0 addition in the hand-written docs (mkdocstrings auto-renders the models on the reference page, but the resource pages, tables, and examples are hand-maintained).
Changes
block_trade_proposalssub-resource: quick-reference rows, a worked example section (with the centi-cents/centicounts gotcha), andBlockTradeProposalsResource/AsyncBlockTradeProposalsResourcemkdocstrings directives. Documents the newmin_ts/max_tsquote filters. Fixes a pre-existing verb error —quotes.accept/quotes.confirmarePUT, notPOST(matches the code andMETHOD_ENDPOINT_MAP).volume_progress()quick-ref row + section.tickersfilter (example + prose).MarginMarketmark-price fields (settlement_mark_price/liquidation_mark_price/reference_price) + the newTickerPricemodel; the now-requiredMarginPosition.subaccount.Verification
uv run --group docs mkdocs build --strict✓ (all new mkdocstrings directives resolve)Generated from a parallel docs-audit pass against the merged 4.1.0 code;
websockets.mdwas audited and intentionally left unchanged (ErrorPayload.market_tickersauto-renders on the reference page).🤖 Generated with Claude Code