wboayue / rust-ibapi / 25639429621

92%

push

github

docs(orders): converge order construction on the fluent path (#549)

* docs(orders): converge order construction on the fluent path

Pick `client.order(&c).buy(n).<type>().submit()` as canonical; demote the
`order_builder::*` free fns to the advanced / client-less layer (BYO order id,
offline construction, hand-composed multi-leg). `submit()` allocates the order
id internally — `next_order_id()` stays public for BYO-id flows but is no
longer shown in canonical examples.

Also folds in v3-api-ergonomics §1 sibling item "Drop client.next_order_id()
from the canonical happy path" — every example sweep touches both.

Examples (10 files): place_order/readme_place_order/submit_order/breakout/
options_purchase/bracket_order/next_order_id (sync), place_order/
order_update_stream (async), conditional_orders (offline). Diagnostic
next_order_id prints removed from connect/stream_bars/contract_details.

Module reframe: order_builder/mod.rs leads with the fluent example, demotes
free fns, points BYO-id callers at OrderBuilder::build_order().

Docs sweep: quick-start, api-patterns (rewrote conditional-orders section to
fluent), order-types (corrected lmt_price -> limit_price, tif: String ->
TimeInForce), extending-api, code-style, troubleshooting. New §"Order
construction" in migration-3.0.md with side-by-side 2.x/3.0 (sync, async,
bracket, BYO-id).

plans/v3-api-ergonomics.md: §1 items checked; §6 marked partial.

* docs(examples): drop monitor boilerplate, dedupe Side enum

Post-ship review (duplication / SRP / composability) flagged:

1. Background monitor thread copy-pasted across 5 sync examples whose stated
   purpose is order construction, not monitoring. Drop the monitor + Arc wrap
   from bracket_order, options_purchase, place_order — each becomes ~30 lines
   shorter. Keep the monitor in submit_order + readme_place_order +
   order_update_stream (those examples explicitly demo the monitor pattern).
   Cross-link from the slimmed examples to submit_order i... (continued)

10 of 10 new or added lines in 1 file covered. (100.0%)

18461 of 20589 relevant lines covered (89.66%)

31.39 hits per line