Skip to content

Clarify image comparison API - #15

Merged
seveibar merged 1 commit into
mainfrom
docs/clarify-image-comparison-api
Aug 7, 2026
Merged

Clarify image comparison API#15
seveibar merged 1 commit into
mainfrom
docs/clarify-image-comparison-api

Conversation

@seveibar

@seveibar seveibar commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • remove documentation for the nonexistent /sharp export
  • document that the looks-same adapter accepts PNG byte buffers
  • document that createDiff returns PNG bytes instead of writing a path
  • call out that SVGs must be rasterized before visual comparison

This documents the contract used by tscircuit/core#3059 and tscircuit/graphics-debug#227.

@seveibar
seveibar merged commit 0c88dd2 into main Aug 7, 2026
2 checks passed
@seveibar
seveibar deleted the docs/clarify-image-comparison-api branch August 7, 2026 21:40
@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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants