Skip to content

Document ui_multi_select params + assert reference/helper parity - #156

Merged
tylercschneider merged 3 commits into
mainfrom
feat/reference-helper-parity
Jul 1, 2026
Merged

Document ui_multi_select params + assert reference/helper parity#156
tylercschneider merged 3 commits into
mainfrom
feat/reference-helper-parity

Conversation

@tylercschneider

Copy link
Copy Markdown
Collaborator

Closes #140

What

The shipped reference (lib/keystone_ui/reference/guide.md, synced into consuming apps via the_local) documented ui_multi_select as a bare (**args) stub, hiding its real signature. This flesh­es it out and adds a guard so the reference can't silently drift from the helper module again.

Findings vs. the issue

The issue listed four omissions (ui_column_picker, ui_multi_select, ui_progress, ui_radio_card) against a stale path (lib/keystone_ui/the_local/agents/keystone-usage.md). On the current reference (reference/guide.md), three of the four were already documented — only ui_multi_select remained a non-informative (**args) stub. That one gap is fixed here; the durable win is the new parity test.

Changes

  • reference/guide.mdui_multi_select(**args)ui_multi_select(name:, label:, options:, selected: []) with a params note (mirrors the component's real initializer).
  • Rebuilt committed locals (the_local/agents/*.md) via rake the_local:build so the synced reference matches.
  • reference_test.rb — new test_reference_documents_every_ui_helper enumerates every ui_* method on KeystoneUiHelper at runtime and asserts each appears in the reference, so future helpers can't drift out of the docs undetected. Plus a targeted assertion on the ui_multi_select signature.

Tests

bundle exec rake test → 430 runs, 0 failures. Parity test verified red (naming the omitted helper) when a mention is removed, green when present.

tylercschneider and others added 3 commits July 1, 2026 14:48
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@tylercschneider
tylercschneider merged commit bd872de into main Jul 1, 2026
4 checks passed
@tylercschneider
tylercschneider deleted the feat/reference-helper-parity branch July 1, 2026 18:55
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.

the_local reference omits ui_column_picker, ui_multi_select, ui_progress, ui_radio_card

1 participant