Skip to content

Unify column accessor API around col/colGroup and deprecate constructor aliases#1911

Draft
zaleslaw with Copilot wants to merge 2 commits into
masterfrom
copilot/unify-column-accessor-apis
Draft

Unify column accessor API around col/colGroup and deprecate constructor aliases#1911
zaleslaw with Copilot wants to merge 2 commits into
masterfrom
copilot/unify-column-accessor-apis

Conversation

Copilot AI commented Jun 25, 2026

Copy link
Copy Markdown

Column accessor creation currently overlaps across constructor-style APIs (column, columnGroup) and DSL APIs (col, colGroup), with inconsistent guidance and discoverability. This PR aligns the model by making col/colGroup the canonical accessors while keeping constructor variants as compatibility aliases.

  • API unification (canonical accessors)

    • Deprecated constructor-style overloads in constructors.kt:
      • column(name|path) and ColumnGroupReference.column(name|path)
      • columnGroup(name|path) and ColumnGroupReference.columnGroup(name|path)
    • Added ReplaceWith(...) hints to guide migration to col(...) / colGroup(...).
  • Behavior alignment guarantees

    • Added focused tests asserting constructor aliases and DSL accessors resolve identically for:
      • top-level col/column
      • top-level colGroup/columnGroup
  • Documentation consistency

    • Updated String API docs to explicitly present col(...) and colGroup(...) as canonical.
    • Clarified column(...) and columnGroup(...) are legacy aliases retained for backward compatibility.
// before (still supported, now deprecated)
column<Int>("age")
columnGroup("name")

// after (canonical)
col<Int>("age")
colGroup("name")

Copilot AI changed the title [WIP] Unify column accessor APIs before 1.0 Unify column accessor API around col/colGroup and deprecate constructor aliases Jun 25, 2026
Copilot AI requested a review from zaleslaw June 25, 2026 11:01
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.

Unify column accessor APIs (column vs col DSL) before 1.0

2 participants