From 3d98790a73725f9fe4c7531becc99c7e255e8263 Mon Sep 17 00:00:00 2001 From: jheer Date: Mon, 16 Sep 2024 19:08:34 -0700 Subject: [PATCH] docs: Update docs and jsdoc. --- docs/api/table.md | 2 +- src/table/ColumnTable.js | 2 +- src/table/Table.js | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/table.md b/docs/api/table.md index 4d6f77d..79187cd 100644 --- a/docs/api/table.md +++ b/docs/api/table.md @@ -581,8 +581,8 @@ Format this table as an [Apache Arrow](https://arrow.apache.org/overview/) table * *offset*: The row offset indicating how many initial rows to skip (default `0`). * *types*: An optional object indicating the [Arrow data type](https://idl.uw.edu/flechette/api/data-types) to use for named columns. If specified, the input should be an object with column names for keys and Arrow data types for values. Type values must be instantiated Flechette [DataType](https://idl.uw.edu/flechette/api/data-types) instances (for example, `float64()`,`dateDay()`, `list(int32())` *etc.*). If a column's data type is not explicitly provided, type inference will be performed. * *useBigInt*: Boolean flag (default `false`) to extract 64-bit integer types as JavaScript `BigInt` values. For Flechette tables, the default is to coerce 64-bit integers to JavaScript numbers and raise an error if the number is out of range. This option is only applied when parsing IPC binary data, otherwise the settings of the provided table instance are used. - * *useDecimalBigInt*: Boolean flag (default `false`) to extract Arrow decimal-type data as BigInt values, where fractional digits are scaled to integers. Otherwise, decimals are (sometimes lossily) converted to floating-point numbers (default). This option is only applied when parsing IPC binary data, otherwise the settings of the provided table instance are used. * *useDate*: Boolean flag (default `true`) to convert Arrow date and timestamp values to JavaScript Date objects. Otherwise, numeric timestamps are used. This option is only applied when parsing IPC binary data, otherwise the settings of the provided table instance are used. + * *useDecimalBigInt*: Boolean flag (default `false`) to extract Arrow decimal-type data as BigInt values, where fractional digits are scaled to integers. Otherwise, decimals are (sometimes lossily) converted to floating-point numbers (default). This option is only applied when parsing IPC binary data, otherwise the settings of the provided table instance are used. * *useMap*: Boolean flag (default `false`) to represent Arrow Map data as JavaScript `Map` values. For Flechette tables, the default is to produce an array of `[key, value]` arrays. This option is only applied when parsing IPC binary data, otherwise the settings of the provided table instance are used. * *useProxy*: Boolean flag (default `false`) to extract Arrow Struct values and table row objects using zero-copy proxy objects that extract data from underlying Arrow batches. The proxy objects can improve performance and reduce memory usage, but do not support property enumeration (`Object.keys`, `Object.values`, `Object.entries`) or spreading (`{ ...object }`). This option is only applied when parsing IPC binary data, otherwise the settings of the provided table instance are used. diff --git a/src/table/ColumnTable.js b/src/table/ColumnTable.js index a903039..1f4be3e 100644 --- a/src/table/ColumnTable.js +++ b/src/table/ColumnTable.js @@ -785,7 +785,7 @@ export class ColumnTable extends Table { // -- Table Output Formats ------------------------------------------------ /** - * Format this table as an Flechette Arrow table. + * Format this table as a Flechette Arrow table. * @param {import('../format/types.js').ArrowFormatOptions} [options] * The Arrow formatting options. * @return {import('@uwdata/flechette').Table} A Flechette Arrow table. diff --git a/src/table/Table.js b/src/table/Table.js index ce79b7a..606d0d2 100644 --- a/src/table/Table.js +++ b/src/table/Table.js @@ -602,7 +602,7 @@ export class Table { * @param {boolean} [order=false] Indicates if the table should be * scanned in the order determined by *orderby*. This * argument has no effect if the table is unordered. - * @property {number} [limit=Infinity] The maximum number of row to scan. + * @property {number} [limit=Infinity] The maximum number of rows to scan. * @property {number} [offset=0] The row offset indicating how many * initial rows to skip. */