Skip to content

Conversation

@phil-opp
Copy link
Contributor

Which issue does this PR close?

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

@github-actions github-actions bot added the arrow Changes to the arrow crate label Oct 29, 2025
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @phil-opp

cc @tustvold

@alamb alamb added the documentation Improvements or additions to documentation label Nov 1, 2025
@alamb alamb merged commit 0051ee3 into apache:main Nov 3, 2025
17 checks passed
@phil-opp phil-opp deleted the document-integration-test-crate branch November 5, 2025 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

arrow Changes to the arrow crate documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ArrowJsonBatch::from_batch is incomplete

2 participants