Document conversion internals and limits
All checks were successful
CI / test (pull_request) Successful in 26s

This commit is contained in:
2026-07-18 16:25:50 +09:00
parent 3ea4d31fd0
commit 2e96d174f2
3 changed files with 64 additions and 8 deletions

View File

@@ -51,6 +51,11 @@ The current tests cover:
- YAML -> TSV flattening
- TSV -> JSON path restoration
- JSON -> XLSX -> JSON round trip
- structured -> structured conversion without CLI/file I/O
- extension normalization and format inference
- ragged table row padding
- conservative cell type inference, including zero-padded identifiers
- conflicting unflatten paths
When adding a new format or path rule, add tests around both directions where
possible.
@@ -96,3 +101,6 @@ go install git.rumginger.org/agent/dataxl/cmd/dataxl@v0.1.0
- Preserve headers as the contract between spreadsheet data and structured data.
- Prefer explicit errors over silent best-effort conversion when a format is unsupported.
- Keep dependencies small unless a format needs a mature parser/writer.
- Keep CLI/file I/O in `main.go`; conversion behavior should remain testable through `convert`.
- Keep format-specific behavior in its structured or table adapter.
- Document round-trip limitations when a representation cannot preserve a value exactly.