You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs(orders): stale "defaults to buy" comment on orders.create example (post-#242) #299
docs/resources/orders.md:52 still carries a stale comment:
action="buy", # ActionLiteral, defaults to "buy"
action no longer has a default — v2.5's #242 makes it a required positional kwarg on orders.create() and removes the default on CreateOrderRequest. The matching breaking-change entry in CHANGELOG.md (v2.5.0 / Breaking changes) and docs/migration.md (v2.4 → v2.5) are accurate; only the resource-page example was missed in the doc sweep.
Why it matters
The misleading inline comment will get copy/pasted into user code as a "look, I can leave action off because it defaults" cue and produce a confusing TypeError: create() requires 'ticker', 'side', 'count', and 'action' after an SDK upgrade. The original silent-default behavior was the exact money-risk that motivated #242.
Suggested fix
Drop the trailing comment so the line reads:
action="buy", # ActionLiteral (required)
Optionally add a short callout above the example pointing at the migration guide:
Since v2.5, count and action are required on the kwarg path — see v2.4 → v2.5 migration.
Activity
docs(orders): drop stale "defaults to buy" on orders.create example (#…
release: 2.6.0 — post-v2.5 independent reviewer SDK audit closure (#295-