Skip to content

docs: align streaming ms_of_day label and document json-raw format#813

Merged
userFRM merged 1 commit into
mainfrom
fix/doc-unit-label-drift
Jun 16, 2026
Merged

docs: align streaming ms_of_day label and document json-raw format#813
userFRM merged 1 commit into
mainfrom
fix/doc-unit-label-drift

Conversation

@userFRM

@userFRM userFRM commented Jun 16, 2026

Copy link
Copy Markdown
Owner

Two documentation label-accuracy fixes for the streaming surface and the CLI.

Streaming ms_of_day label

The streaming ms_of_day field was documented as "exchange-local" in the Rust event structs and FFI structs but "Eastern Time" on the docs page and in every tick schema. Same field, two labels. The field is an unconverted i32 that already carries Eastern Time (US exchange-local time equals ET), so this is a wording fix with no behavioral or data change. All four surfaces now read "Milliseconds since midnight Eastern Time".

The FFI struct comment is emitted by the schema-driven generator, so the correction lives in the emitter source and the checked-in generated file was regenerated from it. The generated-file consistency check passes.

CLI --format json-raw

The CLI accepts four --format values — table, json, json-raw, csv — but the docs and README enumerated only three, leaving json-raw undiscoverable. json-raw is output-significant: it emits dates as raw YYYYMMDD integers (and ms_of_day as raw milliseconds) instead of the ISO-formatted values json produces. Added it, with a short note on its semantics, to both docs-site/docs/cli.md and tools/cli/README.md. The CLI's own inline --format help already enumerated json-raw with its semantics, so no code change was needed there.

Verification

  • cargo fmt --all -- --check clean
  • cargo build -p thetadatadx and -p thetadatadx-ffi build
  • generate_sdk_surfaces --check and generate_docs_site --check both report generated files match
  • python3 scripts/check_docs_consistency.py reports ok
  • No exchange-local string remains anywhere in the repo

🤖 Generated with Claude Code

Standardize the streaming `ms_of_day` field comment on "Eastern Time" so the Rust event structs, the generated FFI structs, and the Python type stubs match the wording already used on the docs page and the tick schema. The field is an unconverted i32 that already carries Eastern Time, so this is a label fix with no data change. The FFI struct wording flows from the schema-driven emitter, so the source template carries the corrected text.

Document the `json-raw` `--format` value in the CLI docs and README so the raw-integer-date output mode is discoverable; `json-raw` emits dates as YYYYMMDD integers instead of the ISO values `json` produces.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@userFRM userFRM enabled auto-merge (squash) June 16, 2026 09:22
@userFRM userFRM merged commit ab8e6c4 into main Jun 16, 2026
43 checks passed
@userFRM userFRM deleted the fix/doc-unit-label-drift branch June 16, 2026 10:02
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