docs: add JSDoc to transform functions and option types#366
Merged
gka merged 1 commit intosvelteplot:mainfrom Feb 14, 2026
Merged
docs: add JSDoc to transform functions and option types#366gka merged 1 commit intosvelteplot:mainfrom
gka merged 1 commit intosvelteplot:mainfrom
Conversation
Document ~24 exported functions and ~10 option types across 11 transform files: stack, dodge, window, shift, bollinger, jitter, centroid, sort, select, recordize, and rename. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
✅ Deploy Preview for svelteplot ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
2 participants
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.
Summary
stack.ts:stackX,stackY,stackMosaicX,stackMosaicY+StackOptions,StackOrder,StackOffsettypes (with per-prop docs)dodge.ts:dodgeX,dodgeY+DodgeXOptions,DodgeYOptions,BaseDodgeOptionstypeswindow.ts:windowX,windowY+WindowOptionstype (all 5 props)shift.ts:shiftX,shiftY+ShiftXOptions,ShiftYOptionstypesbollinger.ts:bollingerX,bollingerY(types already documented)jitter.ts:jitterX,jitterY,jitter(type already documented)centroid.ts:geoCentroidsort.ts:sort(shuffle/reverse already documented)select.ts:select,selectFirst,selectLast,selectMinX,selectMaxX,selectMinY,selectMaxYrecordize.ts:recordizeX,recordizeY,recordize(also fixed/* */→/** */for existing comments)rename.ts:replaceChannels(renameChannels/renameChannelsAndData already documented)Test plan
pnpm run lintpasses (prettier + eslint)🤖 Generated with Claude Code