Skip to content

docs: add JSDoc to data types, channels, and internal type aliases#367

Merged
gka merged 2 commits intosvelteplot:mainfrom
ljodea:docs/jsdoc-data-types
Feb 14, 2026
Merged

docs: add JSDoc to data types, channels, and internal type aliases#367
gka merged 2 commits intosvelteplot:mainfrom
ljodea:docs/jsdoc-data-types

Conversation

@ljodea
Copy link
Copy Markdown
Collaborator

@ljodea ljodea commented Feb 11, 2026

Summary

  • Add JSDoc documentation to internal data types, channel types, and type aliases across 4 files
  • data.ts: RawValue, DataRecord, ResolvedDataRecord (2 props), ScaledDataRecord (6 props), DataRow
  • channel.ts: Channels, ChannelAccessor, ChannelValue, ScaledChannelName, ScaledChannelType, ChannelName
  • index.ts: GenericMarkOptions, CurveName, ConstantAccessor, TransformArg, MapArg, TransformArgsRow, TransformArgsRecord, TransformReturn, AutoMarginStores (4 props), MapIndexFunction, MapIndexObject (1 prop), MapMethod, UsedScales
  • facet.ts: FacetState (2 props: fx, fy), FacetContext, getFacetState

Test plan

  • pnpm run lint passes (prettier + eslint)
  • Verify JSDoc tooltips appear on hover for types like ScaledDataRecord, ChannelAccessor, etc.

🤖 Generated with Claude Code

Document types across 4 files:
- data.ts: RawValue, DataRecord, ResolvedDataRecord, ScaledDataRecord,
  DataRow (with per-prop docs for resolved/scaled record fields)
- index.ts: GenericMarkOptions, CurveName, ConstantAccessor,
  TransformArg, MapArg, TransformArgsRow, TransformArgsRecord,
  TransformReturn, AutoMarginStores, MapIndexFunction, MapIndexObject,
  MapMethod, UsedScales
- channel.ts: Channels, ChannelAccessor, ChannelValue,
  ScaledChannelName, ScaledChannelType, ChannelName
- facet.ts: FacetState (fx, fy props), FacetContext, getFacetState

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify bot commented Feb 11, 2026

Deploy Preview for svelteplot ready!

Name Link
🔨 Latest commit 4305e26
🔍 Latest deploy log https://app.netlify.com/projects/svelteplot/deploys/69906eb2950cfb0008fe30a0
😎 Deploy Preview https://deploy-preview-367--svelteplot.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@gka gka merged commit d563eb5 into svelteplot:main Feb 14, 2026
3 of 4 checks passed
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.

2 participants