Document ui_multi_select params + assert reference/helper parity - #156
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #140
What
The shipped reference (
lib/keystone_ui/reference/guide.md, synced into consuming apps via the_local) documentedui_multi_selectas a bare(**args)stub, hiding its real signature. This fleshes 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 — onlyui_multi_selectremained a non-informative(**args)stub. That one gap is fixed here; the durable win is the new parity test.Changes
reference/guide.md—ui_multi_select(**args)→ui_multi_select(name:, label:, options:, selected: [])with a params note (mirrors the component's real initializer).the_local/agents/*.md) viarake the_local:buildso the synced reference matches.reference_test.rb— newtest_reference_documents_every_ui_helperenumerates everyui_*method onKeystoneUiHelperat runtime and asserts each appears in the reference, so future helpers can't drift out of the docs undetected. Plus a targeted assertion on theui_multi_selectsignature.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.