docs: align streaming ms_of_day label and document json-raw format#813
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two documentation label-accuracy fixes for the streaming surface and the CLI.
Streaming
ms_of_daylabelThe streaming
ms_of_dayfield 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 unconvertedi32that 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
--formatjson-rawThe CLI accepts four
--formatvalues —table,json,json-raw,csv— but the docs and README enumerated only three, leavingjson-rawundiscoverable.json-rawis output-significant: it emits dates as rawYYYYMMDDintegers (andms_of_dayas raw milliseconds) instead of the ISO-formatted valuesjsonproduces. Added it, with a short note on its semantics, to bothdocs-site/docs/cli.mdandtools/cli/README.md. The CLI's own inline--formathelp already enumeratedjson-rawwith its semantics, so no code change was needed there.Verification
cargo fmt --all -- --checkcleancargo build -p thetadatadxand-p thetadatadx-ffibuildgenerate_sdk_surfaces --checkandgenerate_docs_site --checkboth report generated files matchpython3 scripts/check_docs_consistency.pyreports okexchange-localstring remains anywhere in the repo🤖 Generated with Claude Code