Skip to content

Docs: breaking-change docstrings tag the change as v3.0.0 but it shipped in v2.4.0 #265

Closed

Description

@TexasCoding

Summary

Users who go to the docstring / mkdocstrings reference to confirm "when did this break" are pointed at a nonexistent v3.0.0, and won't find the migration on a v2.x branch. Also misleads any future v3.0.0 release-cutter into thinking the change is still pending.

Location

  • kalshi/resources/orders.py:474-483
  • kalshi/models/orders.py:367-375
  • kalshi/models/orders.py:402-409
  • CHANGELOG.md:37-42 (correct — lists v2.4.0)

Evidence

kalshi/resources/orders.py:476: `BREAKING in v3.0.0: previously returned ``list[Order]``...`
kalshi/models/orders.py:370-371 on BatchCreateOrdersResponse: `Spec ``components.schemas.BatchCreateOrdersResponse``. v3.0.0 BREAKING: previously the SDK returned ``list[Order]`` ...`
kalshi/models/orders.py:405-406 on BatchCancelOrdersResponse: `v3.0.0 BREAKING: previously the SDK declared ``-> None`` ...`

CHANGELOG.md:37-42 ships the change under ## 2.4.0 — 2026-05-21 as #194.

Recommended fix

Replace all three v3.0.0 references with v2.4.0 (or, if the intent was to advertise forward-compatibility into v3, say Changed in v2.4.0 explicitly).

Severity & category

medium / consistency, docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions