Skip to content

docs: warn against estimating with rows of other celestial bodies - #7

Merged
kochizufan merged 1 commit into
train/2026-12from
dec26/m1-t4-celestial-note
Oct 27, 2026
Merged

kochizufan merged 1 commit into
train/2026-12from
dec26/m1-t4-celestial-note

Conversation

@kochizufan

Copy link
Copy Markdown
Member

What changes

The note on includeOtherCelestialBodies (rows of the Moon, Mars, ... kept on request) used to say only "do not pass such rows to transformLonLatArrayToProjected in bulk". It now also covers the adapter path: do not pass them through createCandidateTransformer to the estimateCrs of Teiresias. estimateCrs transforms every candidate it is given, so the runtime can stop answering. With Teiresias failing the whole estimate on any implementation-side candidate failure, a failed transformation also makes the estimate fail.

  • README.md / README.ja.md: the bullet in "CRS of other celestial bodies"
  • src/proj-wasm-crs.ts: the JSDoc of includeOtherCelestialBodies, plus the rebuilt dist/proj-wasm-crs.d.ts

No behaviour changes.

Checks (local)

build, typecheck, verify:demo, verify:packed-browser: exit 0; git status --short dist is clean after the build. test hit the existing 9 s / 16 s per-test timeouts of three proj-wasm tests while the machine was heavily loaded (load average above 200). This change does not touch runtime code; see CI for the test run.

🤖 Generated with Claude Code

The note on includeOtherCelestialBodies now also covers passing such
rows through createCandidateTransformer to the estimateCrs of
Teiresias, which transforms every candidate it is given. The README in
both languages and the option's JSDoc (and the rebuilt declaration in
dist) say the same. No behaviour changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kochizufan
kochizufan marked this pull request as ready for review October 27, 2026 09:23
@kochizufan
kochizufan merged commit 8db6f35 into train/2026-12 Oct 27, 2026
5 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.

1 participant