Repository navigation
docs(core,driver,react): document the public API - #235
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
This was referenced Oct 8, 2026
This was referenced Oct 8, 2026
pbroom
force-pushed
the
docs/s0-jsdoc-and-surface
branch
from
October 8, 2026 17:04
251e098 to
34a1680
Compare
pbroom
force-pushed
the
chore/bump-control-kit-workspace
branch
from
October 8, 2026 17:04
039ba97 to
15d85d0
Compare
pbroom
commented
Oct 8, 2026
pbroom
left a comment
pbroom
left a comment
Owner
Author
There was a problem hiding this comment.
Reviewed the full incremental PR and its corrections at b5e0f78dc73e155bc4263f346393cd9cae6268e5. Public API documentation reviewed; gradient validation and workspace provider example corrected. No remaining actionable findings in the reviewed scope.
Independent correction re-reviews and stack preservation verification passed. At the integrated tip, lint, full build/DTS, 2,208 tests, formatting, strict agent checks and 14 built-site Chrome tests passed. All recorded actionable review threads are addressed. Hosted CI is being verified separately; this review does not authorize merge or release.
This was referenced Oct 9, 2026
pbroom
force-pushed
the
chore/bump-control-kit-workspace
branch
from
October 10, 2026 02:39
15d85d0 to
920d85b
Compare
pbroom
force-pushed
the
docs/s0-jsdoc-and-surface
branch
from
October 10, 2026 02:39
b5e0f78 to
92d5ace
Compare
Owner
Author
pbroom
changed the base branch from
chore/bump-control-kit-workspace
to
graphite-base/235
October 10, 2026 19:58
Add JSDoc summaries to every value export across the color-kit facade entry points (root, plane, interop, compute, hct, driver, react) and a runnable @example on every exported function, component and hook, with // → results computed against the built package. Document user-facing option and result fields with @DefaultValue, and add @throws and @see where they apply. Normalise @default to @DefaultValue. Comments only; no code changes. Co-Authored-By: Claude Opus 5.5 <[email protected]>
…ace and export assertGamutTarget from the root Drop BENCHMARK_SELECTED_COLOR_PLANE_RENDERER, COLOR_PLANE_VERTEX_SHADER_SOURCE and COLOR_PLANE_FRAGMENT_SHADER_SOURCE from the color-kit/react barrel; they stay internal to ColorPlane. Export assertGamutTarget from the core root in addition to color-kit/plane. The facade export test now asserts both. BREAKING CHANGE: color-kit/react no longer exports the three ColorPlane internals. Co-Authored-By: Claude Opus 5.5 <[email protected]>
pbroom
force-pushed
the
docs/s0-jsdoc-and-surface
branch
from
October 10, 2026 20:01
92d5ace to
8e0e8de
Compare
pbroom
added a commit
that referenced
this pull request
Oct 10, 2026
…237) Validate the active gamut with core's assertGamutTarget in createColorState, setColorActiveGamut, createMultiColorModel, setMultiColorActiveGamut and getColorDisplayStyles, so 'p3' throws the same TypeError as the core plane queries instead of rendering sRGB. The reducers also reject a missing gamut. sampleSliderGradient now throws a RangeError for steps below 2, and the multi-color entry builders throw a TypeError for colors that are neither strings nor objects instead of storing an empty color. Found while documenting the public API in #235. Each finding was reproduced against the built package before the fix, has a regression test, and its affected JSDoc examples were recomputed. lint, build, test, format:check, typecheck, size, check:artifacts, check:preprod and agents:check:strict pass. Part of the color-kit assessment stack. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
pbroom
added a commit
that referenced
this pull request
Oct 10, 2026
…#238) saturate/desaturate clamped chroma to [0, 0.4], so wide-gamut colors above 0.4 lost chroma (saturate lowered it, desaturate(c, 0) changed it). Chroma is now only clamped below at 0, like lighten/darken clamp lightness to its domain; 0.4 stays as the saturate step span. planeHue returned the model's own hue on HSL, HSV and HCT planes, but its callers (gamut boundary, contrast and chroma-band queries and their result hue) expect an OKLCH hue. It now converts the fixed color, and falls back to the model hue's most saturated color when that fixed color is achromatic. Found while documenting the public API in #235. Each finding was reproduced against the built package before the fix, has a regression test, and its affected JSDoc examples were recomputed. lint, build, test, format:check, typecheck, size, check:artifacts, check:preprod and agents:check:strict pass. Part of the color-kit assessment stack. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
pbroom
added a commit
that referenced
this pull request
Oct 10, 2026
…tep precision (#239) parseColorInputExpression evaluated each absolute % as a span fraction and added range[0] once to the whole result, so on an offset range any expression that multiplied or combined percents was wrong ('50% * 2' on [100, 200] gave 200). Every absolute % is now a position in the range, like a lone '50%'; relative input keeps span fractions. getColorInputPrecisionFromStep used an absolute rounding tolerance, so steps below 1e-7 looked like whole numbers and returned 0. The tolerance is now relative to the step, and such steps return the 6-decimal cap. Found while documenting the public API in #235. Each finding was reproduced against the built package before the fix, has a regression test, and its affected JSDoc examples were recomputed. lint, build, test, format:check, typecheck, size, check:artifacts, check:preprod and agents:check:strict pass. Part of the color-kit assessment stack. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
pbroom
added a commit
that referenced
this pull request
Oct 10, 2026
ColorInput and ColorStringInput spread the rest props (including aria-label) onto the wrapper div and also set aria-label on the inner input, so a consumer label was rendered twice. aria-label and aria-labelledby are now taken out of the rest props and applied only to the inner input; a consumer label replaces the default, and aria-labelledby alone suppresses the default aria-label. Found while documenting the public API in #235. Each finding was reproduced against the built package before the fix, has a regression test, and its affected JSDoc examples were recomputed. lint, build, test, format:check, typecheck, size, check:artifacts, check:preprod and agents:check:strict pass. Part of the color-kit assessment stack. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
pbroom
added a commit
that referenced
this pull request
Oct 10, 2026
… PlaneWithSense (#241) The gamut-boundary, chroma-band and gradient query specs budgeted `steps ?? 48`, but their solvers default to 100, 12 and 16 samples, and adaptive sampling ignores steps. Budgets now use the shared solver defaults and estimate adaptive paths from adaptiveTolerance and adaptiveMaxDepth (calibrated against traced point counts). PlaneWithSense was exported but nothing produced it (sense() returns PlaneSense), so it is removed from the core and plane barrels. BREAKING CHANGE: the PlaneWithSense type is removed; use Plane & PlaneSense. Found while documenting the public API in #235. Each finding was reproduced against the built package before the fix, has a regression test, and its affected JSDoc examples were recomputed. lint, build, test, format:check, typecheck, size, check:artifacts, check:preprod and agents:check:strict pass. Part of the color-kit assessment stack. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
This branch was successfully deployed
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
1 participant
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.
Slice S0 of the docs overhaul. The generated API pages need complete JSDoc, so this PR documents the whole public API and trims the public surface.
Commits
docs(core,driver,react): document the public API(d930462). Comments only, across 88 files; a comment-stripped comparison confirms no code changed. Every value export now has a JSDoc summary, and every function has an@example.refactor(react,core)!(251e098). RemovesBENCHMARK_SELECTED_COLOR_PLANE_RENDERERandCOLOR_PLANE_{VERTEX,FRAGMENT}_SHADER_SOURCEfromcolor-kit/react, which is a hard cut-over of internal constants. Also exportsassertGamutTargetfrom the root, addstest-exportsassertions, and includes a minor changeset.Coverage (symbols with JSDoc)
256/513 → 510/510 deduplicated. Function
@example: 82 → all.Example accuracy
A harness ran all 149 example blocks against the built package: 199
// →results matched and none failed. The few that couldn't be run automatically were checked by hand. One wrong existing comment, in themixexample, is fixed.Bundle sizes are identical before and after the JSDoc commit, and TypeDoc reports no warnings. All repo gates pass.
Part of the color-kit assessment stack (#204 → #235).
🤖 Generated with Claude Code