Skip to content

Deprecate schPinSpacing in favor of schPinStyle#648

Merged
seveibar merged 1 commit intomainfrom
codex/add-deprecation-notice-for-schpinspacing
May 2, 2026
Merged

Deprecate schPinSpacing in favor of schPinStyle#648
seveibar merged 1 commit intomainfrom
codex/add-deprecation-notice-for-schpinspacing

Conversation

@seveibar
Copy link
Copy Markdown
Contributor

@seveibar seveibar commented May 2, 2026

Motivation

  • schPinSpacing is being deprecated in favor of the richer schPinStyle configuration to steer users toward the preferred API for schematic pin layout.

Description

  • Added a JSDoc deprecation note @deprecated Use schPinStyle instead. to schPinSpacing on PinHeaderProps (lib/components/pin-header.ts), JumperProps (lib/components/jumper.ts), and BaseGroupProps (lib/components/group.ts).
  • Regenerated documentation and type artifacts by running the repository generation scripts which updated README.md and generated/PROPS_OVERVIEW.md to surface the deprecation.
  • This change is purely a documentation annotation and does not alter runtime validation or types beyond the added comments.

Testing

  • Ran the generation scripts bun scripts/generate-component-types.ts, bun scripts/generate-manual-edits-docs.ts, bun scripts/generate-readme-docs.ts, and bun scripts/generate-props-overview.ts, and they completed successfully.
  • Executed unit tests bun test tests/chip1-basic.test.ts, bun test tests/chip2-schematic-port-arrangement.test.ts, bun test tests/pin-header.test.ts, and bun test tests/group.test.ts, and all tests passed.
  • Performed typecheck bunx tsc --noEmit and formatting bun run format, both of which succeeded.

Codex Task

@seveibar seveibar merged commit fd362a3 into main May 2, 2026
5 checks passed
@seveibar seveibar deleted the codex/add-deprecation-notice-for-schpinspacing branch May 2, 2026 23:16
@tscircuitbot
Copy link
Copy Markdown
Contributor


Thank you for your contribution! 🎉

PR Rating:
Impact: Tiny

Track your contributions and see the leaderboard at: tscircuit Contribution Tracker


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants