Skip to content

Docs: mention embedded pHYs scale; ignore local benchmark/dev dirs - #25

Open
kalidke wants to merge 2 commits into
mainfrom
docs/phys-scale-mentions
Open

kalidke wants to merge 2 commits into
mainfrom
docs/phys-scale-mentions

Conversation

@kalidke

@kalidke kalidke commented Aug 27, 2026

Copy link
Copy Markdown
Member

Docs-and-hygiene only — no code or version change. Intended to merge with (or ride along to) the next real update; no registration needed for this alone.

Docs: The pHYs scale embedding shipped in v0.4.7, but the places users look first still described filename as a bare save. This adds the note to:

  • the render docstring kwarg list (src/interface.jl)
  • the RenderConfig.filename field doc (src/types.jl)
  • the README kwargs table and the Output Format example (now shows save_image(...; pixel_size_nm=info.pixel_size_nm))

save_image's docstring and api_overview.md already documented the capability, so they are untouched.

Hygiene: .gitignore gains /benchmark/ (local perf harness; supersedes the unmerged chore/gitignore-benchmark branch) and /dev/ (dev output artifacts), so git status comes up clean.

🤖 Generated with Claude Code

https://claude.ai/code/session_015XyPjjDBD9tGVSeKtvSrfm

kalidke and others added 2 commits August 27, 2026 12:59
The capability shipped in v0.4.7 but the render docstring, the
RenderConfig field docs, and the README still described filename as a
bare save. Point all three at the pHYs embedding; save_image and
api_overview.md already covered it.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015XyPjjDBD9tGVSeKtvSrfm
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015XyPjjDBD9tGVSeKtvSrfm
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.

1 participant