Skip to content

docs(orders): drop stale "defaults to buy" on orders.create example - #303

Merged
TexasCoding merged 1 commit into
mainfrom
docs/299-orders-action-stale
May 21, 2026
Merged

TexasCoding merged 1 commit into
mainfrom
docs/299-orders-action-stale

Conversation

@TexasCoding

Copy link
Copy Markdown
Owner

Closes #299.

Replaces the misleading inline # ActionLiteral, defaults to "buy" comment on the orders.create() example with # ActionLiteral (required). v2.5's #242 made both action and count required on the kwarg path; the example would otherwise teach users a pattern that raises TypeError after 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).

@claude

claude Bot commented May 21, 2026

Copy link
Copy Markdown

Code Review — PR #303

Overview: One-line documentation fix in docs/resources/orders.md: replaces the incorrect inline comment # ActionLiteral, defaults to "buy" with # ActionLiteral (required), reflecting v2.5's change (#242) that made action a required parameter.


Correctness ✅

The fix is accurate. v2.5 removed the action="buy" default, so the old comment actively taught users a pattern that raises TypeError on upgrade. The new comment matches reality.

Notably, orders.md line 177 already carried # required on another action kwarg in a different example — this PR brings line 52 into consistency with that.

Scope ✅

Checked the rest of the docs tree for similar stale "defaults to" phrasing:

  • docs/migration.md — correctly describes the historical behavior (no change needed).
  • events.md — with_nested_markets defaults to False describes a current default (accurate, unrelated).
  • All other action="buy" occurrences in docs are explicit call-site values, not implied defaults — those are correct as-is.

No other stale instances found. The PR scope is exactly right.

Style / Conventions ✅

Matches the existing comment style in the file (# TypeName (qualifier)). No trailing whitespace, no formatting drift.

Test Coverage ✅

Doc-only change; no test changes needed or expected.

Security / Performance

N/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.

@TexasCoding
TexasCoding merged commit c6f9a63 into main May 21, 2026
5 checks passed
@TexasCoding
TexasCoding deleted the docs/299-orders-action-stale branch May 22, 2026 01:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(orders): stale "defaults to buy" comment on orders.create example (post-#242)

1 participant