Copilot commented on code in PR #247: URL: https://github.com/apache/datasketches-rust/pull/247#discussion_r3889707139
########## README.md: ########## @@ -81,7 +81,9 @@ See the [API documentation](https://docs.rs/datasketches) for configuration, acc The minimum supported Rust version is 1.86.0. The crate currently supports little-endian targets only. -Supported serialization formats are tested with fixtures produced by Apache DataSketches Java, C++, and Go through the [DataSketches TCK](https://github.com/apache/datasketches-tck). When values must hash identically across language implementations, use the compatibility wrappers in `hash::value`. +Supported serialization formats are tested with fixtures produced by Apache DataSketches Java, C++, and Go through the [DataSketches TCK](https://github.com/apache/datasketches-tck). + +Serialization compatibility does not imply that an ordinary Rust `Hash` implementation produces the same update bytes as another language. When sketches must represent the same inputs across implementations, use `hash::value::raw_bytes` for bytes and strings, `canonical_float` for floating-point values, `sign_extend` for short integers passed to HLL or CPC, and `natural_extend` for short integers passed to Bloom filters. Other DataSketches implementations skip empty strings, so skip them before updating when that behavior matters. Review Comment: The README’s cross-language hashing guidance mixes fully-qualified and unqualified module references (e.g. `hash::value::raw_bytes` vs `canonical_float`). Since these are modules under `datasketches::hash::value`, readers may misinterpret `canonical_float`, `sign_extend`, and `natural_extend` as in-scope items rather than modules (and may miss the actual constructors like `...::from_f64`). Align the paths so they’re consistently discoverable from README context. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
