Skip to content

docs(orders): correct breaking-change version tags v3.0.0 → v2.4.0 - #274

Merged
TexasCoding merged 1 commit into
mainfrom
docs/265-v240-not-v300
May 21, 2026
Merged

TexasCoding merged 1 commit into
mainfrom
docs/265-v240-not-v300

Conversation

@TexasCoding

Copy link
Copy Markdown
Owner

Closes #265

Part of #273 (post-v2.4 audit), Wave 0 docs patch.

@claude

claude Bot commented May 21, 2026

Copy link
Copy Markdown

Code Review — PR #274: docs(orders): correct breaking-change version tags v3.0.0 → v2.4.0

Overview

Purely a documentation fix: four docstring occurrences of v3.0.0 (a nonexistent future version) are corrected to v2.4.0, which is the actual release where batch_create / batch_cancel breaking changes shipped. The format is also lightly improved from the terse v3.0.0 BREAKING: opener to the more conventional Changed in v2.4.0 (breaking):.


Accuracy ✅

CHANGELOG.md confirms the breaking changes landed under ## 2.4.0 — 2026-05-21 (issue #194). Every substitution in this PR is correct.

Completeness ✅ (beats the issue)

Issue #265 listed three locations. This PR silently catches a fourth (batch_cancel resource docstring at kalshi/resources/orders.py:511) that the issue missed but is an exact parallel case. Good catch.

Location Fixed?
kalshi/models/orders.py — BatchCreateOrdersResponse ✅
kalshi/models/orders.py — BatchCancelOrdersResponse ✅
kalshi/resources/orders.py — batch_create docstring ✅
kalshi/resources/orders.py — batch_cancel docstring (not in issue) ✅
CHANGELOG.md — already said v2.4.0 no change needed

Code Quality ✅

  • Changes are surgical — exactly the lines that needed updating, nothing else.
  • New wording (Changed in v2.4.0 (breaking):) reads better than the old v3.0.0 BREAKING: label and matches the style used in CHANGELOG entries.
  • No logic, types, or tests are affected; no test changes needed.

Suggestions (minor / non-blocking)

  • None. This is as minimal and correct as a docs patch can be.

Verdict: LGTM. Accurate fix, better than the issue it closes (extra location caught), zero blast radius. Ready to merge.

@TexasCoding
TexasCoding merged commit b815095 into main May 21, 2026
5 checks passed
@TexasCoding
TexasCoding deleted the docs/265-v240-not-v300 branch May 21, 2026 11:12
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: breaking-change docstrings tag the change as v3.0.0 but it shipped in v2.4.0

1 participant