docs: clarify primitive schema byte order#1161
Open
singhvishalkr wants to merge 1 commit into
Open
Conversation
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.
Motivation
Primitive schema docs list the supported types, but they do not state how fixed-width numeric values are ordered on the wire. That leaves client implementers to infer byte order when producers and consumers are not using the same client library.
Modifications
INT8is a single byte,FLOATandDOUBLEuse IEEE 754 bit patterns, andBYTESpayloads keep application-defined ordering.4.0.xand4.2.x).Verifying this change
corepack yarn install --immutablegit diff --checkcorepack yarn typecheckfails on existing non-doc TypeScript issues inmatomoClientModule.tsandsrc/theme/Blog*files.$env:NODE_OPTIONS='--max_old_space_size=16000'; corepack yarn docusaurus buildpasses; it emits existing site-wide broken-link and SSG warnings outside the changed schema docs.Contribution Checklist
Fixes #1142