Commit 0051ee3
authored
Document limitations of the
# Which issue does this PR close?
- Closes #8684
# Rationale for this change
The crate is apparently only intended for internal use. However, the
crate documentation does not mention this anywhere. Given that the crate
is severely incomplete in certain areas, we should document this
clearly.
# What changes are included in this PR?
- add a disclaimer to the crate-level docs that the crate is only
intended for integration-testing the Arrow project itself and not
recommended for outside use
- Document that `ArrowJsonBatch::from_batch` is deliberately incomplete
and only supports `Int8` arrays right now
# Are these changes tested?
doc-only change
# Are there any user-facing changes?
yes, the mentioned doc changesarrow_integration_test crate (#8738)1 parent 87154eb commit 0051ee3
1 file changed
+19
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
18 | | - | |
| 18 | + | |
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
23 | 31 | | |
24 | 32 | | |
25 | 33 | | |
| |||
1043 | 1051 | | |
1044 | 1052 | | |
1045 | 1053 | | |
| 1054 | + | |
| 1055 | + | |
| 1056 | + | |
| 1057 | + | |
| 1058 | + | |
| 1059 | + | |
| 1060 | + | |
| 1061 | + | |
| 1062 | + | |
| 1063 | + | |
1046 | 1064 | | |
1047 | 1065 | | |
1048 | 1066 | | |
| |||
0 commit comments