Skip to content

Commit 5138cb6

Browse files
docs: clarify vortex-row is not production-ready (#8949)
Updated the README introduction to explicitly state that `vortex-row` is "**not ready for production use**" Signed-off-by: Claude <noreply@anthropic.com> Co-authored-by: Claude <noreply@anthropic.com>
1 parent caedc63 commit 5138cb6

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

vortex-row/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# vortex-row
22

3-
`vortex-row` provides an experimental row-oriented byte encoder for Vortex arrays. It
4-
produces byte strings that can be compared lexicographically to sort rows according to the
5-
configured column ordering.
3+
`vortex-row` provides an experimental row-oriented byte encoder for Vortex arrays. It is
4+
**not ready for production use**. It produces byte strings that can be compared
5+
lexicographically to sort rows according to the configured column ordering.
66

77
Only supported Vortex logical types are accepted. Extension types are rejected until their
88
logical sort semantics are defined.
99

1010
## Experimental Format
1111

12-
The row encoding byte layout is experimental. Its exact bytes, supported type set, and
13-
edge-case semantics may change between Vortex releases.
12+
The row encoding byte layout is experimental and not ready for production. Its exact bytes,
13+
supported type set, and edge-case semantics may change between Vortex releases.
1414

1515
Do not persist row-encoded bytes or use them as a stable interchange format. They are intended
1616
for internal sort-key and row-key operations where the encoder version, schema, and sort

0 commit comments

Comments
 (0)