(arrow-rs) branch master updated: update BYTE_STREAM_SPLIT documentation (#6212)

[alamb]

This is an automated email from the ASF dual-hosted git repository.

alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git


The following commit(s) were added to refs/heads/master by this push:
     new 79ffdc4c6 update BYTE_STREAM_SPLIT documentation (#6212)
79ffdc4c6 is described below

commit 79ffdc4c67acf5dfb09afca8116d92a4f1d2ba73
Author: Ed Seidl <etse...@users.noreply.github.com>
AuthorDate: Thu Aug 8 12:55:28 2024 -0700

    update BYTE_STREAM_SPLIT documentation (#6212)
---
 parquet/src/basic.rs | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/parquet/src/basic.rs b/parquet/src/basic.rs
index 880d804a4..a12c9d860 100644
--- a/parquet/src/basic.rs
+++ b/parquet/src/basic.rs
@@ -294,13 +294,14 @@ pub enum Encoding {
     /// The ids are encoded using the RLE encoding.
     RLE_DICTIONARY,
 
-    /// Encoding for floating-point data.
+    /// Encoding for fixed-width data.
     ///
     /// K byte-streams are created where K is the size in bytes of the data 
type.
-    /// The individual bytes of an FP value are scattered to the corresponding 
stream and
+    /// The individual bytes of a value are scattered to the corresponding 
stream and
     /// the streams are concatenated.
     /// This itself does not reduce the size of the data but can lead to 
better compression
-    /// afterwards.
+    /// afterwards. Note that the use of this encoding with 
FIXED_LEN_BYTE_ARRAY(N) data may
+    /// perform poorly for large values of N.
     BYTE_STREAM_SPLIT,
 }