Skip to content

Commit 0051ee3

Browse files
authored
Document limitations of the arrow_integration_test crate (#8738)
# 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 changes
1 parent 87154eb commit 0051ee3

File tree

1 file changed

+19
-1
lines changed
  • arrow-integration-test/src

1 file changed

+19
-1
lines changed

arrow-integration-test/src/lib.rs

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,19 @@
1515
// specific language governing permissions and limitations
1616
// under the License.
1717

18-
//! Support for the [Apache Arrow JSON test data format](https://github.com/apache/arrow/blob/master/docs/source/format/Integration.rst#json-test-data-format)
18+
//! Partial support for the [Apache Arrow JSON test data format](https://github.com/apache/arrow/blob/master/docs/source/format/Integration.rst#json-test-data-format)
1919
//!
2020
//! These utilities define structs that read the integration JSON format for integration testing purposes.
2121
//!
2222
//! This is not a canonical format, but provides a human-readable way of verifying language implementations
23+
//!
24+
//! <div class="warning">
25+
//!
26+
//! This crate is **only intended for integration testing the
27+
//! [Arrow project](https://github.com/apache/arrow-rs)**. It is not [intended for usage outside of
28+
//! this context](https://github.com/apache/arrow-rs/issues/8684#issuecomment-3433193158).
29+
//!
30+
//! </div>
2331
2432
#![doc(
2533
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
@@ -1043,6 +1051,16 @@ fn create_null_buf(json_col: &ArrowJsonColumn) -> Buffer {
10431051

10441052
impl ArrowJsonBatch {
10451053
/// Convert a [`RecordBatch`] to an [`ArrowJsonBatch`]
1054+
///
1055+
/// <div class="warning">
1056+
///
1057+
/// This function is **deliberately incomplete**! As noted in the crate-level documentation,
1058+
/// this crate is only intended for use within the Arrow project itself.
1059+
///
1060+
/// Right now, this function only supports `DataType::Int8` columns. Other data types will lead
1061+
/// to an empty `ArrowJsonColumn`.
1062+
///
1063+
/// </div>
10461064
pub fn from_batch(batch: &RecordBatch) -> ArrowJsonBatch {
10471065
let mut json_batch = ArrowJsonBatch {
10481066
count: batch.num_rows(),

0 commit comments

Comments
 (0)