Repository navigation
docs(orders): drop stale "defaults to buy" on orders.create example - #303
Conversation
Code Review — PR #303Overview: One-line documentation fix in Correctness ✅The fix is accurate. v2.5 removed the Notably, Scope ✅Checked the rest of the docs tree for similar stale "defaults to" phrasing:
No other stale instances found. The PR scope is exactly right. Style / Conventions ✅Matches the existing comment style in the file ( Test Coverage ✅Doc-only change; no test changes needed or expected. Security / PerformanceN/A for a documentation comment change. Verdict: LGTM. Clean, minimal, and closes a real user-facing footgun from the v2.5 upgrade. Ready to merge. |
Closes #299.
Replaces the misleading inline
# ActionLiteral, defaults to "buy"comment on theorders.create()example with# ActionLiteral (required). v2.5's #242 made bothactionandcountrequired on the kwarg path; the example would otherwise teach users a pattern that raisesTypeErrorafter upgrade.One-line diff in
docs/resources/orders.md. No code, no behavior change.Part of the post-v2.5 audit closure (Wave W0 docs).