You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by ky...@apache.org on 2026/05/18 16:34:46 UTC

(arrow-js) branch kyle/docs-record-batch created (now dcba161)

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

kylebarron pushed a change to branch kyle/docs-record-batch
in repository https://gitbox.apache.org/repos/asf/arrow-js.git


      at dcba161  docs: Add RecordBatch class to rendered docs

This branch includes the following new commits:

     new dcba161  docs: Add RecordBatch class to rendered docs

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



(arrow-js) 01/01: docs: Add RecordBatch class to rendered docs

Posted by ky...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

kylebarron pushed a commit to branch kyle/docs-record-batch
in repository https://gitbox.apache.org/repos/asf/arrow-js.git

commit dcba161895e831a1ef379d03433ec86a1e6f9063
Author: Kyle Barron <ky...@developmentseed.org>
AuthorDate: Mon May 18 12:34:36 2026 -0400

    docs: Add RecordBatch class to rendered docs
---
 src/recordbatch.ts | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/recordbatch.ts b/src/recordbatch.ts
index f70c69f..58d1ace 100644
--- a/src/recordbatch.ts
+++ b/src/recordbatch.ts
@@ -46,7 +46,11 @@ export interface RecordBatch<T extends TypeMap = any> {
     [Symbol.isConcatSpreadable]: true;
 }
 
-/** @ignore */
+/**
+ * A RecordBatch is a collection of equal-length columns conforming to a
+ * particular {@link Schema}. A {@link Table} is composed of one or more
+ * RecordBatches.
+ */
 export class RecordBatch<T extends TypeMap = any> {
 
     /**