Document platform endianness support - #11056
Open
sdf-jkl wants to merge 1 commit into
Open
Conversation
sdf-jkl
marked this pull request as ready for review
September 10, 2026 21:38
Member
Author
github-actions
Bot
added
parquet
Rich-T-kid
reviewed
Sep 11, 2026
Rich-T-kid
left a comment
Rich-T-kid
left a comment
Contributor
There was a problem hiding this comment.
I think it may be better to just place this comment in the readme or in some other centralized place instead of repeating it
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
2 participants
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.
Which issue does this PR close?
Related to #6917.
Rationale for this change
The endianness support and testing expectations discussed in #6917 are not currently stated in the repository's user documentation. Users should be able to find these limitations when choosing a crate.
What changes are included in this PR?
Add a Platform Support section to the root README and the API landing page of every published library crate. It states that only little-endian platforms are officially supported and tested in CI, while big-endian platforms are untested and may not work correctly. Big-endian fixes are welcome on a best-effort basis, with no compatibility guarantee.
Each crate includes the full paragraph because it can be consumed independently.
Are these changes tested?
Documentation only.
cargo fmt --all -- --checkandgit diff --checkpass. Verified that the root README and all 25 published library crates contain identical policy wording.Are there any user-facing changes?
Documents the platform support and testing expectations. No API or runtime behavior changes.